Compare commits
No commits in common. "1ae59d0a8ff7fbb880677f5a5d712109aa1aea4c" and "cf104c859d7e9f76e83c6c7d932944f3a3573f74" have entirely different histories.
1ae59d0a8f
...
cf104c859d
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/source/
|
!docs
|
||||||
docs/source/autodoc
|
docs/build
|
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/autodoc/bmlsa src/bmlsa --force'
|
sh 'sphinx-apidoc -o docs/source/ 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: ''])
|
||||||
}
|
}
|
||||||
|
53
docs/source/bmlsa.rst
Normal file
53
docs/source/bmlsa.rst
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
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:
|
@ -3,7 +3,7 @@ import sys
|
|||||||
|
|
||||||
# Configure system path
|
# Configure system path
|
||||||
|
|
||||||
sys.path.insert(0, os.path.abspath("../../src/"))
|
sys.path.insert(0, os.path.abspath("../src/"))
|
||||||
|
|
||||||
# Configuration file for the Sphinx documentation builder.
|
# Configuration file for the Sphinx documentation builder.
|
||||||
#
|
#
|
||||||
|
@ -7,11 +7,10 @@ Welcome to BMLSA's documentation!
|
|||||||
=================================
|
=================================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Contents:
|
:caption: Contents:
|
||||||
|
|
||||||
autodoc/**/modules
|
modules
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
7
docs/source/modules.rst
Normal file
7
docs/source/modules.rst
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
bmlsa
|
||||||
|
=====
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
bmlsa
|
Loading…
x
Reference in New Issue
Block a user