Compare commits

...

6 Commits

Author SHA1 Message Date
1ae59d0a8f Updated system path insertion in 'conf.py'
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good
2023-04-28 15:54:55 -05:00
d6edc0e317 Changing documentation generation structure
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good
2023-04-28 15:47:27 -05:00
a8b820523a Merge branch 'develop'
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good
2023-04-28 14:29:46 -05:00
ebb27556b5 Merge branch 'develop'
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good
2023-04-28 14:11:37 -05:00
d75a83585c Merge branch 'master' of https://git.reslate.systems/ydeng/bmlsa and fingerprint archives
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good
2023-04-28 08:25:38 -05:00
b9f4c74168 Pipeline now tests the installed command
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good
2023-04-22 16:20:12 -05:00
6 changed files with 6 additions and 65 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

@ -3,7 +3,7 @@ import sys
# 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.
#

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