Changing documentation generation structure
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good

This commit is contained in:
Harrison Deng 2023-04-28 15:47:27 -05:00
parent a8b820523a
commit d6edc0e317
5 changed files with 5 additions and 64 deletions

4
.gitignore vendored
View File

@ -213,5 +213,5 @@ pyrightconfig.json
# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
output
!docs
docs/build
!docs/source/
docs/source/autodoc

2
Jenkinsfile vendored
View File

@ -18,7 +18,7 @@ pipeline {
sh 'rm -rf ./dist/*'
sh 'rm -rf ./docs/build/*'
sh "python -m build"
sh 'sphinx-apidoc -o docs/source/ src/bmlsa --force'
sh 'sphinx-apidoc -o docs/source/autodoc/bmlsa src/bmlsa --force'
sh 'make -C docs html'
publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: 'docs/build/html', reportFiles: 'index.html', reportName: 'Documentation', reportTitles: ''])
}

View File

@ -1,53 +0,0 @@
bmlsa package
=============
Submodules
----------
bmlsa.aligner module
--------------------
.. automodule:: bmlsa.aligner
:members:
:undoc-members:
:show-inheritance:
bmlsa.cli module
----------------
.. automodule:: bmlsa.cli
:members:
:undoc-members:
:show-inheritance:
bmlsa.datatypes module
----------------------
.. automodule:: bmlsa.datatypes
:members:
:undoc-members:
:show-inheritance:
bmlsa.exceptions module
-----------------------
.. automodule:: bmlsa.exceptions
:members:
:undoc-members:
:show-inheritance:
bmlsa.io module
---------------
.. automodule:: bmlsa.io
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: bmlsa
:members:
:undoc-members:
:show-inheritance:

View File

@ -7,10 +7,11 @@ Welcome to BMLSA's documentation!
=================================
.. toctree::
:glob:
:maxdepth: 2
:caption: Contents:
modules
autodoc/**/modules
Indices and tables

View File

@ -1,7 +0,0 @@
bmlsa
=====
.. toctree::
:maxdepth: 4
bmlsa