Please fix the sphinx documentation
Issue #24
resolved
Dear maintainer,
while packaging csb43 for Debian the build of the documentation failed with a bunch of errors, see below.
As documentation for this package is important I am reluctant to upload it without documentation. It would be nice if those errors could be fixed at the soonest.
sphinx-build -C doc build/html
Running Sphinx v4.5.0
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 7 source files that are out of date
updating environment: [new config] 7 added, 0 changed, 0 removed
reading sources... [ 14%] source/converter
reading sources... [ 28%] source/csb
reading sources... [ 42%] source/formats
reading sources... [ 57%] source/homebank
reading sources... [ 71%] source/index
reading sources... [ 85%] source/ofx
reading sources... [100%] source/utils
/<<PKGBUILDDIR>>/doc/source/csb.rst:8: ERROR: Unknown directive type "automodule".
.. automodule:: csb43.csb43
:members:
/<<PKGBUILDDIR>>/doc/source/csb.rst:14: ERROR: Unknown directive type "autoclass".
.. autoclass:: csb43.csb43.File
:members:
:special-members:
/<<PKGBUILDDIR>>/doc/source/csb.rst:18: ERROR: Unknown directive type "autoclass".
.. autoclass:: csb43.csb43.ClosingFile
:members:
:special-members:
/<<PKGBUILDDIR>>/doc/source/csb.rst:25: ERROR: Unknown directive type "autoclass".
.. autoclass:: csb43.csb43.Account
:members:
:special-members:
/<<PKGBUILDDIR>>/doc/source/csb.rst:29: ERROR: Unknown directive type "autoclass".
.. autoclass:: csb43.csb43.ClosingAccount
:members:
:special-members:
/<<PKGBUILDDIR>>/doc/source/csb.rst:36: ERROR: Unknown directive type "autoclass".
.. autoclass:: csb43.csb43.Transaction
:members:
:special-members:
/<<PKGBUILDDIR>>/doc/source/csb.rst:43: ERROR: Unknown directive type "autoclass".
.. autoclass:: csb43.csb43.Item
:members:
....
[38/1923]
.. autoattribute:: csb43.formats.TABLIB_FORMATS
/<<PKGBUILDDIR>>/doc/source/formats.rst:14: ERROR: Unknown directive type "autoattribute".
.. autoattribute:: csb43.formats.DICT_FORMATS
/<<PKGBUILDDIR>>/doc/source/formats.rst:16: ERROR: Unknown directive type "autofunction".
.. autofunction:: csb43.formats.convertFromCsb
/<<PKGBUILDDIR>>/doc/source/formats.rst:18: ERROR: Unknown directive type "autofunction".
.. autofunction:: csb43.formats.convertFromCsb2Dict
/<<PKGBUILDDIR>>/doc/source/formats.rst:20: ERROR: Unknown directive type "autofunction".
.. autofunction:: csb43.formats.convertFromCsb2Tabular
/<<PKGBUILDDIR>>/doc/source/homebank.rst:6: ERROR: Unknown directive type "automodule".
.. automodule:: csb43.homebank
:members:
/<<PKGBUILDDIR>>/doc/source/homebank.rst:9: ERROR: Unknown directive type "autoclass".
.. autoclass:: csb43.homebank.Transaction
:members:
:special-members:
/<<PKGBUILDDIR>>/doc/source/homebank.rst:16: ERROR: Unknown directive type "autofunction".
.. autofunction:: csb43.homebank.converter.convertFromCsb
/<<PKGBUILDDIR>>/doc/source/homebank.rst:18: ERROR: Unknown directive type "autoattribute".
.. autoattribute:: csb43.homebank.converter.PAYMODES
/<<PKGBUILDDIR>>/doc/source/index.rst:6: ERROR: Unknown directive type "automodule".
.. automodule:: csb43
/<<PKGBUILDDIR>>/doc/source/ofx.rst:8: ERROR: Unknown directive type "automodule".
.. automodule:: csb43.ofx
:members:
:inherited-members:
/<<PKGBUILDDIR>>/doc/source/ofx.rst:15: ERROR: Unknown directive type "autofunction".
.. autofunction:: csb43.ofx.converter.convertFromCsb
/<<PKGBUILDDIR>>/doc/source/ofx.rst:17: ERROR: Unknown directive type "autoattribute".
.. autoattribute:: csb43.ofx.converter.PAYMODES
/<<PKGBUILDDIR>>/doc/source/utils.rst:6: ERROR: Unknown directive type "automodule".
.. automodule:: csb43.utils
:members:
:undoc-members:
Comments (3)
-
reporter -
repo owner - changed status to open
-
repo owner - changed status to resolved
commit e2d0842
- Log in to comment
I see that the documentation has to be built from an environment with csb43 installed which gives me a working documentation tree. There are still left those Warnings: