Skip to content
Advertisement

Tag: python-sphinx

How to use the sphinx plugin of pybuilder?

I try to create a python package using pybuilder and wonder how to make use of the sphinx plugin. I already initiated a sphinx documentation scaffold via sphinx-quickstart and activated the sphinx plugin within the build.py file of pybuilder. The following displays my current build.py: However, when I run the pyb command to build the package, pybuilder does not generate

How to exclude imports from automodapi output?

I am trying to use automodapi to generate documentation for my Django project. When I call automodapi like this: the output includes all imported classes and functions, e.g, the Django Model class, in the index of Functions and Classes. I would like to exclude the imports and only list those classes and functions declared in the module I specified. I

Python Sphinx exclude patterns

I’m generating documentation with Sphinx for project with structure like this : I want to exclude tests, and workflow/definition from documentation. I tried exclude pattern in docs/conf.py But even though workflow/definitions are still automatically generated. Could someone show me correct exclude pattern how to ignore ‘definitions’ folder ? Answer exclude_patterns can be used to exclude source files (reStructuredText files) from

adding xml content to sphinx generated doc

So here is my problem. I’m trying to generate documentation for my project using sphinx and managed to get the basic working, like adding modules and images. So a basic index.rst would look like: ‘tvb’ here contains top level modules and links to sub-packages and so on. This seems to work fine and the html documentation is generated accordingly. However

Advertisement