Skip to content
Snippets Groups Projects
Commit 4540102f authored by Blaß, Michael's avatar Blaß, Michael :speech_balloon:
Browse files

updated docs build process for rtd.

parent 19b1be66
Branches
Tags
No related merge requests found
Pipeline #8412 passed
Showing
with 170 additions and 12 deletions
...@@ -68,7 +68,7 @@ instance/ ...@@ -68,7 +68,7 @@ instance/
.scrapy .scrapy
# Sphinx documentation # Sphinx documentation
docs/_build/ docs/source/_build/
# PyBuilder # PyBuilder
target/ target/
......
...@@ -2,10 +2,8 @@ ...@@ -2,10 +2,8 @@
# Read the Docs configuration file # Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2 version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx: sphinx:
builder: html builder: html
configuration: docs/source/conf.py configuration: docs/source/conf.py
...@@ -16,9 +14,8 @@ formats: all ...@@ -16,9 +14,8 @@ formats: all
# Optionally set the version of Python and requirements required to build your docs # Optionally set the version of Python and requirements required to build your docs
python: python:
version: 3.7 version: 3.9
install: install:
- requirements: docs/requirements.txt - requirements: docs/requirements.txt
- method: pip - method: setuptools
path: . path: .
system_packages: true
\ No newline at end of file
numpy Sphinx==3.5.1
scipy sphinx-rtd-theme==0.5.1
matplotlib sphinxcontrib-apidoc==0.3.0
soundfile
sphinxcontrib_apidoc
https://gitlab.rrz.uni-hamburg.de/bal7668/hmm/-/archive/master/hmm-master.zip
\ No newline at end of file
apollon.aplot module
====================
.. automodule:: apollon.aplot
:members:
:undoc-members:
:show-inheritance:
apollon.audio module
====================
.. automodule:: apollon.audio
:members:
:undoc-members:
:show-inheritance:
apollon.container module
========================
.. automodule:: apollon.container
:members:
:undoc-members:
:show-inheritance:
apollon.datasets module
=======================
.. automodule:: apollon.datasets
:members:
:undoc-members:
:show-inheritance:
apollon.fractal module
======================
.. automodule:: apollon.fractal
:members:
:undoc-members:
:show-inheritance:
apollon.hmm.poisson module
==========================
.. automodule:: apollon.hmm.poisson
:members:
:undoc-members:
:show-inheritance:
apollon.hmm package
===================
.. automodule:: apollon.hmm
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 4
apollon.hmm.poisson
apollon.hmm.utilities
apollon.hmm.utilities module
============================
.. automodule:: apollon.hmm.utilities
:members:
:undoc-members:
:show-inheritance:
apollon.io.io module
====================
.. automodule:: apollon.io.io
:members:
:undoc-members:
:show-inheritance:
apollon.io.json module
======================
.. automodule:: apollon.io.json
:members:
:undoc-members:
:show-inheritance:
apollon.io package
==================
.. automodule:: apollon.io
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 4
apollon.io.io
apollon.io.json
apollon.onsets module
=====================
.. automodule:: apollon.onsets
:members:
:undoc-members:
:show-inheritance:
apollon package
===============
.. automodule:: apollon
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 4
apollon.hmm
apollon.io
apollon.signal
apollon.som
Submodules
----------
.. toctree::
:maxdepth: 4
apollon.aplot
apollon.audio
apollon.container
apollon.datasets
apollon.fractal
apollon.onsets
apollon.segment
apollon.tools
apollon.types
apollon.segment module
======================
.. automodule:: apollon.segment
:members:
:undoc-members:
:show-inheritance:
apollon.signal.container module
===============================
.. automodule:: apollon.signal.container
:members:
:undoc-members:
:show-inheritance:
apollon.signal.critical\_bands module
=====================================
.. automodule:: apollon.signal.critical_bands
:members:
:undoc-members:
:show-inheritance:
apollon.signal.features module
==============================
.. automodule:: apollon.signal.features
:members:
:undoc-members:
:show-inheritance:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment