documentation

Python-Sphinx: How to document one file with functions?

由 …衆ロ難τιáo~ 提交于 2019-12-03 06:13:57
问题 I have a python file with functions (lib.py), without classes. Each function has the following style: def fnc1(a,b,c): ''' This fonction does something. :param a: lalala :type a: str :param b: hahaha :type b: int :param c: hohoho :type c: int :rtype: int ''' print a d = b + c return d I just want to document each function (inputs and outputs) with Sphinx. After doing sphinx-quickstart, I defined the path in conf.py with my lib.py. But the output html file (welcome page) is empty. If I write

Is doxygen the (de facto) standard documentation syntax specification? [closed]

由 非 Y 不嫁゛ 提交于 2019-12-03 05:40:57
问题 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 . We all have the good habit of documenting our code, right? Nowadays, in-code documentation itself has a syntax. It's almost like a programming language onto itself. The questions are: What (How many) documentation syntax specifications exist? Is there a standard documentation

How to document all exceptions a function might throw?

由 烈酒焚心 提交于 2019-12-03 05:39:18
问题 If you have a public function which may throw an exception which uses other (private or public) helper functions which can also throw exceptions I think you should document what exceptions the public function can throw and this includes exceptions thrown by the helper functions . Something like this (using Doxygen): /** * @throw Exception ... * @throw ExceptionThrownByHelper ... * @throw ExceptionThrownByHelpersHelper ... */ void theFunction() { helperWhichMayThrowException(); } and

Grouping overloads in doxygen

由 限于喜欢 提交于 2019-12-03 05:32:25
In my library I have a lot of function overloads of the form: /// \brief Does thing. /// /// \details The thing that is done is very special. template<typename T> void do_stuff(const T& t); /// \brief Does thing repeatedly. /// \copydetails do_stuff() template<typename T> void do_stuff(const T& t, std::size_t x); This, in general, works and is quite nice but creates the same documentation section multiple times. What I want is, to group those functions together. Have on detail description and each of the overloads annotated with it's brief description. I'm also not averse to aliases that could

sphinx automodule: how to reference classes in same module?

由 依然范特西╮ 提交于 2019-12-03 05:31:09
I am trying to use the sphinx autodoc extension and specifically the automodule directive to automatically generate documentation for django app I am working on. The problem is that I want to create internal references to different classes within the module, without having to use autoclass and autofunction on every single class/function within the project. For a source file like this: # source_code.py class A: """docs for A """ pass class B: """docs for B with :ref:`internal reference to A <XXXX-some-reference-to-A-XXXX>` """ pass I would like to be able to have a sphinx documentation file

Create html documentation for C# code [closed]

由 痴心易碎 提交于 2019-12-03 05:27:58
问题 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 currently working on a C# project and VisualAssist generates these fancy /// <summary></summary> comments for me and I've been using them do document my code. I assume there must be a way to use these comments to create HTML documentation like those done by Doxygen or Javadoc. How do I do that? 回答1: Doxygen or

Is there a list of known web crawlers? [closed]

由 ℡╲_俬逩灬. 提交于 2019-12-03 05:27:45
Closed. This question is off-topic. It is not currently accepting answers. Learn more . Want to improve this question? Update the question so it's on-topic for Stack Overflow. I'm trying to get accurate download numbers for some files on a web server. I look at the user agents and some are clearly bots or web crawlers, but many for many I'm not sure, they may or may not be a web crawler and they are causing many downloads so it's important for me to know. Is there somewhere a list of know web crawlers with some documentation like user agent, IPs, behavior, etc? I'm not interested in the

show *only* docstring in Sphinx documentation

由 两盒软妹~` 提交于 2019-12-03 05:21:36
问题 Sphinx has a feature called automethod that extracts the documentation from a method's docstring and embeds that into the documentation. But it not only embeds the docstring, but also the method signature (name + arguments). How do I embed only the docstring (excluding the method signature)? ref: http://sphinx.pocoo.org/ext/autodoc.html 回答1: I think what you're looking for is: from sphinx.ext import autodoc class DocsonlyMethodDocumenter(autodoc.MethodDocumenter): def format_args(self):

Whole site compilation of markdown/pandoc? [closed]

由 随声附和 提交于 2019-12-03 05:09:05
问题 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 . With Sphinx-doc, you can create a bunch of ReStructureText files, with an index.rst file which includes a table of contents macro that auto generates a table of contents from the other included files, and a conf.py that acts as a compilation config. You can then compile the lot into a single python-doc-style site,

how to generate api documentation [closed]

由 匆匆过客 提交于 2019-12-03 04:46:07
问题 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 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
订阅 documentation