I use sphinx to generate HTML and PDF documentation, and was using latex until now to generate PDF, but now looking at swapping for rinohtype. I'm looking at se
I’d like to customize the Sphinx Python domain to recognize a custom field within a docstring for a method and generate custom HTML for it. For example, l
With Markdown, I can simply: [`a link with monospace font`](https://www.example.com) a link with monospace font Note how the above line is properly rendered by
My goal is to create a set of PDF documents using Sphinx in an automated process, except I've found I'm too limited in what document specific information I can
I have been trying to create a .yml file to automatically generate python docs with Sphinx and the Autosummary extension. This is supposed to perform just at th
Following code makes Sphinx autosummary fail: @dataclasses.dataclass class Foo: bar: int class FooChild(Foo): pass My autosummary template (_template
I am using Sphinx to document a code base docString; in python. I have code like this - class foo(np.ndarray): def foo_func(): pass class bar(foo):
I'm trying to use Sphinx's autosummary extension to generate the documentation automatically for the methods of a single file. I have the following folder struc
when I use the :scale: property on my pixel art, its very blurry. How can i change the scaling method to nearest neighbor for sharper scaling in Sphinx/reST?
For some reason, the subtitles become the chapters in the PDF generated for my docs by ReadTheDocs. Check it out here: https://yarsaw.namantech.me/_/downloads/e
In building my documentation I'm running into a lot of warning messages such as the following: /home/X/Y/src/core/include/math/bigintntl/transformntl.h:92: warn
I'm trying to document a Django project using Sphinx's autodoc extension. I have two main problems: It's documenting excessivelly in some modules (importing doc
I am trying to use ..autosummary to document a module that replaces itself with a class upon import (lazy importing). Without lazy imports the module looks like
In Sphinx, is there a way to set a default value for a directive option in conf.py, so that it is always used whenever I use that directive? In particular, I am
For classes/functions, sphinx's autosummary extension can generate a nice table summarizing the list of available classes/functions in a particular module, such
I'm having trouble with sphinx and autosummary. Apparently, sphinx is unable to document inherited instance attributes. For some reason, the resulting error is
I am using to generate documentation for codebase. While building the docs, I could see that they were built for some modules only and many were left undocument
If I have a file foo.baz.py: from foo.bar.baz import Quux, Quuux __all__ = ['Quux', 'Quuux'] I'd like to document the api as follows: Baz === .. currentmodul
The package I want to document with Sphinx contains pure Python modules (ok) + a C/C++ library bind using pybind11. There are a lot of dependencies that can not
Let's say we have the following module testmodule.py with a TestClass definition: """This is a test module""" class TestClass: """ This is a simple des