Firstly, Sphinx doesn’t generate PDF output by itself, though there are three general methods to get from Sphinx source files to PDF output: Use the Latex builder, and then a separate tool like latex2pdf to generate the PDF output Use the Sphinx plugin from the rst2pdf project Use the rinoh Sphinx builder provided by rinohtype … Read more
Cross-referencing is done using a ref :ref:`label-name` You can provide your labels using: .. _label-name: See: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref Roles are used to create custom interpreted text. See: http://docutils.sourceforge.net/docs/ref/rst/directives.html#role
Try adding add_module_names = False in conf.py
I had the same problem with the celery @task decorator. You can also fix this in your case by adding the correct function signature to your rst file, like this: .. autoclass:: Bus :members: .. automethod:: open(self) .. automethod:: some_other_method(self, param1, param2) It will still document the non-decorator members automatically. This is mentioned in the … Read more
Use the “parsed-literal” directive. .. parsed-literal:: ./home/user/somecommand-|version| Source: https://groups.google.com/forum/?fromgroups=#!topic/sphinx-dev/ABzaUiCfO_8:
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 quicker with Epydoc. You … Read more
Thanks to @StevePiercy I found this documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon conf.py html_favicon = ‘favicon.ico’ I put favicon.ico in my source folder, next to my .rst-files and it is working as expected: https://global-coffee-data-standard.readthedocs.io/en/latest/index.html
If I get the question right, you want a link from your documentation to the original source file. You can do this by adding the sphinx.ext.viewcode extension to your conf file (under extensions entry). This will create a “source” link for every header of a class, method, function, etc. Clicking the link will open the … Read more
This answer addresses point 2 of your question. Yes, doxygen partly has those features. You can have math formulas, that can be rendered either through a local Latex install, or through MathJax, a Javascript rendering library. As with Latex, these can be either “embedded” into text, or as a separate unit in the text flow. … Read more
The only thing you need to host sphinx documentation is a static file server (the search works without a back end, see my answer here. That said, using a private readthedocs server is probably over-engineering. Just deploy the files to a static file server and point the base URL (e.g. docs.myapp.com) to the index.html file. … Read more