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 not the subtitles. It works correctly when I'm in another document and references the FAQ, only in the

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_8fkR.log, if you want to report the issue to the developers. Please also report this if it was a user

Closed . This question is opinion-based . It is not currently accepting answers. Want to improve this question? Update the question so it can be answered with facts and citations by editing this post . Closed last year . Should 2 different versions of a user guide use a different canonical URL ? Documentation version 1.1.0.Final : <link rel="canonical" href="http://docs.foo.org/1.1.0.Final/index.html"> Documentation version 1.2.0.Final : <link rel="canonical" href="http://docs.foo.org/1.2.0.Final/index.html"> Or should 2 different versions of a user guide use the same canonical URL ?

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 = test GENERATE_LATEX = NO GENERATE_MAN = NO GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = awkout.txt

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 ServiceStack (I couldn't find it)? If not has anybody solved the problem in some other way. You can provide metadata descriptions for each of your web services by attributing your Request DTOs with [Api] and [ApiMember] attributes. This information will be displayed on the dynamic metadata pages. Another option is

I am working on an app wich will become quite huge in time. I have decided to use JsDoc3 and DocStrap to document all modules. Modules are defined via require.js and in some places they are nested up to 3 or 4 levels deep. Untill now I understand that JsDoc documentation is split into four main sections: Modules, Classes, Tutorials, Globals. Each section has a header dropdown menu and a sidebar each of them listing all of the modules in liniar fashion, alphabetically. I was wondering if there are options to display/group modules and Classes somehow to reflect the project structure. I saw a git

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] :c Value for C. ## # my_func does stuff # @macro my_hash h1 def my_func h1 end ## # other_func does

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 to generate collapsable code sections? ax. if includ[ing] the source for methods, etc, [...] makes the