Changing documentation generation structure
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good
This commit is contained in:
parent
a8b820523a
commit
d6edc0e317
4
.gitignore
vendored
4
.gitignore
vendored
@ -213,5 +213,5 @@ pyrightconfig.json
|
|||||||
# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
|
# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
|
||||||
|
|
||||||
output
|
output
|
||||||
!docs
|
!docs/source/
|
||||||
docs/build
|
docs/source/autodoc
|
2
Jenkinsfile
vendored
2
Jenkinsfile
vendored
@ -18,7 +18,7 @@ pipeline {
|
|||||||
sh 'rm -rf ./dist/*'
|
sh 'rm -rf ./dist/*'
|
||||||
sh 'rm -rf ./docs/build/*'
|
sh 'rm -rf ./docs/build/*'
|
||||||
sh "python -m 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'
|
sh 'make -C docs html'
|
||||||
publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: 'docs/build/html', reportFiles: 'index.html', reportName: 'Documentation', reportTitles: ''])
|
publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: 'docs/build/html', reportFiles: 'index.html', reportName: 'Documentation', reportTitles: ''])
|
||||||
}
|
}
|
||||||
|
@ -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:
|
|
@ -7,10 +7,11 @@ Welcome to BMLSA's documentation!
|
|||||||
=================================
|
=================================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:glob:
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Contents:
|
:caption: Contents:
|
||||||
|
|
||||||
modules
|
autodoc/**/modules
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
@ -1,7 +0,0 @@
|
|||||||
bmlsa
|
|
||||||
=====
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 4
|
|
||||||
|
|
||||||
bmlsa
|
|
Loading…
x
Reference in New Issue
Block a user