Category : sphinx

Suppose, I have the following four RST files: index.rst .. _index: .. documentation master file, created by sphinx-quickstart on Wed May 5 09:01:16 2021. Welcome to X’s documentation! ================================== .. toctree:: :maxdepth: 2 :caption: Contents: src/namespace_MyNamespace Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` namespace_MyNamespace.rst .. _namespace_MyNamespace: =========== MyNamespace =========== namespace ========= Class ..

Read more

I have tried .. autoclass:: ChatCommandHandler() with no luck to remove the signature, is this possible with an extension to make a custom option like :exclude-signature or something. my extensions: extensions = [ ‘sphinx.ext.napoleon’, ‘sphinx.ext.autodoc’, ‘sphinx.ext.intersphinx’, ‘exception_hierarchy’, ‘attributetable’, ‘silence’, ‘sphinx_autodoc_typehints’ ] first 3 are ext’s from sphinx, attributetable is a custom ext for a table ..

Read more

I want to install glfw on my Mac using homebrew, but I’m getting some errors which I can’t fix through homebrew. To install the glfw package, I first need to install cmake and sphinx-doc. I assume the problem is that sphinx-doc needs a dependency called alabaster, but I’m not sure how I install it to ..

Read more

I want to use Sphinx to generate html documents, and although I can generate them successfully, Sphinx does not recognize elements like :param content:. Wrong document Correct document Here you can see the specific code file, using . make.bat html to generate the documentation: Shared/sphinx-document-generation at master – Andy-AO/Shared After checking the documentation of the ..

Read more

For module level functions, is there a way to auto generate content that frequently appears, namely ‘Returns: None’ , so that it wouldn’t be repeatedly written in many docstrings? I’ve seen some formatting using napoleon_custom_sections, but that doesn’t seem to be my direct use case. Example would be if the following generated documentation that contained ..

Read more

Metaclass class RequestMeta(type): def new(mcs, what, bases, attrs): _attrs = {name: decimal_to_string(attr) if callable(attr) else attr for name, attr in attrs.items()} return super().new(mcs, what, bases, _attrs) when we import RequestMeta for metaclass, sphinx can’t generate members Class_name(metaclass=RequestMeta) def test """ Get test :return: .. code-block:: json [ { "message":"test", "timestamp": 123 } ] """ #test.rst ..

Read more

Having such class marked with pytest.mark.parametrize: @pytest.mark.parametrize(‘app_lang’, MobileAppLanguageMark.all(), scope=’session’) class MobileBaseCase(BaseCase): def foo(self, a, b): """ assadasdasda """ return a,b I’m trying to use sphinx autodoc to generate the docs. This is mobile_base_case.rst file: MobileBaseCase ========================= .. autoclass:: plugin.lib.mobile.common.mobile_base_case.MobileBaseCase :members: :undoc-members: :show-inheritance: The resulting html file after make html has only I’ve also tried using ..

Read more

I have developed two projects: A package (projA) with Sphinx documentation A Flask app (projB), which utilizes projA and lists it in the requirements.txt file. Therefore, projA would be installed in the virtual environment that coincides with projB. My question is: How can I safely serve the documentation from the static files in the /docs/build/html ..

Read more