documentation

Consider that I have a complex class structure where many elements inherit from other elements. I may have a method GetStuff(string stuffName, int count) defined in an interface, which is inherited by other interface, which is then implemented abstractly by an abstract class, which is then implement explicit in a concrete class etc. etc... How should I handle inherited members such as GetStuff() when documenting my code with XML comments which will be used with a tool such as Doxygen or Sandcastle? It seems wrong to just copy and paste the same description at each level. Should I be

import myModule as myModule with this code works import and I can make my doc import myPackage.myModule as myModule with this I get "No module named myPackage.myModule" Doesnt matter if this file exist in root directory or in myPackage directory. in RST-File I have not mentioned about myModule, I want to document other file that just import this module. Alex Morega Sphinx needs to be able to import your code, to generate documentation for classes and functions. You probably need to add your project's root folder to sys.path in Sphinx. You can do this from the Sphinx conf.py file: import sys

I want to add documentation in my code by means of comment lines. Is there any standard format for this? For example, consider the code below: class Arithmetic { // This method adds two numbers, and returns the result. // dbNum1 is the first number to add, and dbNum2 is second. // The returning value is dbNum1+dbNum2. static double AddTwoNumbers(double dbNum1, double dbNum2); } For this example code, is there any better way of writing the comment lines? For c++ there isn't a standard, like javadoc, but certain documentation tools are popular and common to use. Off the top of my head, I can

I recently started using Swagger for my documentation but there are few things that are still unclear to me. I created my YAML document and now I would like to be able to share my documentation in a .pdf or HTML/Javascript page with the rest of my team. I can't use SwaggerHub because they don't have private repositories and Swagger Editor doesn't appear to allow to share the panel on the right. Just to be clear, I would like to be able to get something like: What am I missing? I'm biased as I work on swaggerhub, but that's what the project is for: https://swaggerhub.com From there, you can

I'm writing some documentation using Sphinx. Is there a way to format headings within a page which do not become part of the TOC? Ideally with some hierarchy that is reflected in formatting? E.g. I want to do My page TOC heading =================== Subheading (not in TOC, and should be formatted e.g. smaller than the heading) +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Sub-subheading (not in TOC, and formatted e.g. smaller than the subheading) ########################################################################### Any other suggestions for how to markup the text so that

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 methoda(data): "Gets A ..." ... def methodb(data): "Gets B ..." ... As seen above, the docstring has a table