I have problems starting with Sphinx on my Python3 code.
I read some tutorials and think I understand it. I also looked in some
example code on GitHub (project: backintime).
But in the result I see only the name of the main module, not more.
I use sphinx and python3.6 on Debian unstable.
Because I saw it in an example I name the main module explicite. But
what I would expect is that Sphinx looking in each py-file by itself.
This is the folder and structure with some (not all) files
.
├── doc
│ ├── build
│ │ ├── doctrees
│ │ │ ├── environment.pickle
│ │ │ ├── feedybus.doctree
│ │ │ ├── index.doctree
│ │ │ └── modules.doctree
│ │ └── html
│ │ ├── feedybus.html
│ │ ├── genindex.html
│ │ ├── index.html
│ │ ├── modules.html
│ │ ├── objects.inv
│ │ ├── py-modindex.html
│ │ ├── search.html
│ │ ├── searchindex.js
│ │ ├── _sources
│ │ │ ├── feedybus.rst.txt
│ │ │ ├── index.rst.txt
│ │ │ └── modules.rst.txt
│ │ └── _static
│ │ ├── ajax-loader.gif
│ │ ├── alabaster.css
│ │ ├── basic.css
│ │ ├── comment-bright.png
│ │ ├── comment-close.png
│ │ ├── comment.png
│ │ ├── custom.css
│ │ ├── doctools.js
│ │ ├── documentation_options.js
│ │ ├── down.png
│ │ ├── down-pressed.png
│ │ ├── file.png
│ │ ├── jquery.js
│ │ ├── minus.png
│ │ ├── plus.png
│ │ ├── pygments.css
│ │ ├── searchtools.js
│ │ ├── underscore.js
│ │ ├── up.png
│ │ ├── up-pressed.png
│ │ └── websupport.js
│ ├── Makefile
│ └── source
│ ├── conf.py
│ ├── feedybus.rst
│ ├── index.rst
│ ├── modules.rst
│ ├── _static
│ └── _templates
├── feedybus
│ ├── application.py
│ ├── basics.py
│ ├── config.py
│ ├── data.py
│ ├── entrieslistview.py
│ ├── fetchfeeds.py
│ ├── graphic
│ │ ├── bullet.svg
│ │ ├── checked.png
│ │ ├── exit.png
│ │ ├── ...etc...
│ ├── __init__.py
│ ├── __main__.py
│ ├── make.bat
│ ├── Makefile
│ ├── treeview.py
│ └── window.py
├── Feedybus.sh
This are IMO the relevant lines from conf.py
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# ...
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
]
# ...
napoleon_include_private_with_doc = True
The index.rst is untouched by me.
But modules.rst and feedybus.rst
$ cat doc/source/modules.rst
common
======
.. toctree::
:maxdepth: 4
feedybus
$ cat doc/source/feedybus.rst
Feedybus
========
.. automodule:: feedybus
:members:
:undoc-members:
:show-inheritance:
The file feedybus/__init__.py is empty.
The file feedybus/__main__.py as functions with docstrings like this
def _SetupLogging(size, n, debug):
"""Setup the logging mechanism and return the logger object.
Args:
size (int): Maximum size of a log file in KiloBytes.
n (int): Maximum number of log files keeped.
debug (bool): Debug-Level on or off
Returns:
logging.Logger:
"""
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
