documentation-generation

I have installed Sphinx in order to document some python modules and class I'm working on. While the markup language looks very nice, I haven't managed to auto-document a python code. Basically, I have the following python module: SegLib.py And A class called Seg in it. I would like to display the docstrings of the class and module within the generated sphinx document, and add further formatted text to it. My index.rst looks like this: Contents: .. toctree:: :maxdepth: 2 chapter1.rst and chapter1.rst : This is a header ================ Some text, *italic text*, **bold text** * bulleted list.

I've developed a pretty extense API, and I have it on Postman, which works pretty nice. Now I have to generate an html doc to keep it versioned inside /docs along with my sources. Is there a tool or a way to achieve this? I really don't want to write all this documentation. Sharing the postman collection is not an option. I recently had the same problem and I did not find anything. So I created a simple tool to do it. It is a very basic javascript application written with react.js. At the moment it is very basic, but I'm working on it, so any feature request is welcome. You can use it for free

I'm having issues with Doxygen recognizing namespaces and modules. I believe the issue surrounds whether to place the \addtogroup within the namespace or outside the namespace. Example 1, outside the namespace: /*! * \addtogroup Records * @{ */ //! Generic record interfaces and implementations namespace Records { //! Describes the record interface class Interface; } // End namespace Records /*! @} End of Doxygen Groups*/ Example 2 - within namespace //! Generic record interfaces and implementations namespace Records { /*! * \addtogroup Records * @{ */ //! Describes the record interface class

I need to write some api documentation for a REST API that I've created. Are there tools that will stub out a nice html output similar in style to the underscore api documentation? Or perhaps something that will output something as a twitter bootstrap styled html? I see that docco does annoated code, but I'm actually just looking to document the API only. Ideally I'd like to point a tool at the controller file and have it generate documentation about the methods and routes but not show any source code unless I specifically call out examples. apiDoc creates a documentation from API annotations

I created a wonderful GitHub Pages website for my little project , and I added some other pages into the gh-pages branch. My problem is that, everytime I regenerate the website from 'Settings=>Automatic Page Generator', everything is cleaned up and I have to restore the files manually. Is there a way to prevent, or work around this? It would have been much better if the Automatic Generator was just overwriting his stuff without removing existing files. Checkout the gh-pages branch. mkdir _layouts move index.html to _layouts edit _layouts/index.html replace the the inner html of the contents

There seems to be a plethora of documentation tools for Python. Another one that I've run across is epydoc. It seems like Sphinx is the de facto standard, because it's used to generate the official Python docs. Can someone please sort out the current state of Python's documentation tools for me? epydoc and Sphinx are different types of tools. They are the same in that they: Both use ReST via docutils . Both are very Pythonic in their focus Both can generate HTML and PDF documentation They are different in their focus. Epydoc is focused on API (Developer) documentation. You get more results

Although related to this question about LaTeX being used outside mathematics and academia , I'm specifically wondering if anyone uses or is familiar with anyone that uses LaTeX for generating any type of documentation relating to software. If so, could you say whether or not you like LaTeX and the purposes for which you use it? Thanks. I mostly write academic papers with LaTeX. However, my research has to do with software documentation, so I actually deal with some of these concerns. The best thing about LaTeX is that you are concerned with content and structure, not just visual layout. This

Sphinx is a Python library to generate nice documentation from a set of ReST formatted text files. Not the tool used for full-text searching I'm also fully aware of doxygen / phpdoc tools. I'm trying to figure out if there is a way of using Sphinx to document php projects? or even any other non-python languages? http://sphinx.pocoo.org/ Sphinx and ReST can be used as generic documentation tools, in my experience. There's nothing about Sphinx which obligates you to only use it for Python-based projects. For example, in my work, I've used it to build a user guide and an XML-RPC API reference. In