documentation

问题 I'm updating a FAQ for a fairly big project and I would like to add an index of the questions at the top of the page, so it becomes easier for users to find what they're looking for. The Sphinx documentation toctree article states "The special entry name self stands for the document containing the toctree directive. This is useful if you want to generate a “sitemap” from the toctree." This is what I want. The problem is that self seem broken and only includes the current documents title and

问题 I have a utils module in my package. It consists of several misc standalone methods that do not require instantiation. I would like to place some generic comments/docstring inside this utils file, such as: import os import json """ Miscellaneous methods that help in <<blah blah>> Does not require explicit instantiation. The following actions can be performed: =============== =============== Action Method =============== =============== Get a :meth:`methoda` Get b :meth:`methodb` """ def

问题 This question was migrated from Software Engineering Stack Exchange because it can be answered on Stack Overflow. Migrated 8 years ago . If you put a MainPage.dox file in Doxygen's search path, it will add it to the output in Doxygen/html above the source documentation. But can you have multiple files like MainPage.dox? Or are you limited to one? 回答1: Doxygen will recognize and parse any file that has a *.dox extension and include it in the resulting documentation. What those files will

问题 I am trying to use some Doxygen filter for Visual Basic in Windows. I started with Vsevolod Kukol filter, based on gawk. There are not so many directions. So I started using his own commented VB code VB6Module.bas and, by means of his vbfilter.awk, I issued: gawk -f vbfilter.awk VB6Module.bas This outputs a C-like code on stdin. Therefore I redirected it to a file with: gawk -f vbfilter.awk VB6Module.bas>awkout.txt I created this Doxygen test.cfg file: PROJECT_NAME = "Test" OUTPUT_DIRECTORY =

问题 Closed . This question needs to be more focused. It is not currently accepting answers. Want to improve this question? Update the question so it focuses on one problem only by editing this post. Closed last year . What are the options for documenting a ServiceStack bases web services and I'm not talking about a one line string. I would like to be able to document, in detail (which can be long), return types, possible HTTP responses, add detailed examples etc. Is there any support for this in

问题 I've got what i assumed was a fairly basic yard macro usage where i have a Hash structure with a number of options that is shared between multiple functions. I was hoping to use a macro simply to prevent me having to replicate this structure all over the place but it doesn't seem to work like that. What i expected to work was: # @macro [new] my_hash # @param $1 [Hash,Array<Hash>] Inputted my_hash # @option $1 [String] :a Value for A. # @option $1 [String] :b Value for B. # @option $1 [String]

问题 I am creating internal documentation for a C++ project using Doxygen. I am having Doxygen include the source for methods, etc., but this makes the page kind of hard to scan. I'd like it to behave like rdoc and hide the source in a block that is collapsed by default. I thought that HTML_DYNAMIC_SECTIONS might let me do this, but alas, the changelog says that option only affects diagrams and graphs. Maybe I could do it by editing the LAYOUT_FILE ? Anyhow, smart people, how can I coerce Doxygen

问题 I am trying to link my sphinx documentation with read the docs. I can build the documentation locally but when i try to have read the docs automatically generate the documentation i get the following error: Sphinx Standard Error Making output directory... Exception occurred: File "/var/build/user_builds/mousedb/checkouts/latest/Docs/source/conf.py", line 25, in <module> from mousedb import settings ImportError: No module named mousedb The full traceback has been saved in /tmp/sphinx-err-n

问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed last year . I'm working on a project that requires Numpy documentation. In my Java days, I remember having linters that checked for Javadoc adherence in Eclipse/IDEA; is there an equivalent that checks for Numpy documentation style adherence? I know about PEP257, but it doesn't seem to have any specific checks for Numpy

问题 I have a preexisting MVC app that I added Web API and Web API Self Documentation using Nuget. While the Web API controllers function fine (return valid responses to HTTP requests) the Help controller is not finding any Web API methods to document. In the Help controller Index action "Configuration.Services.GetApiExplorer().ApiDescriptions" is returning with 0 results. I even went as far as copying the entire "HelpPage" area from another functioning web app. What populated ApiDescriptions and