Skip to content
Snippets Groups Projects
Commit bedff939 authored by Oscar Gustafsson's avatar Oscar Gustafsson :bicyclist:
Browse files

Swap to sphinx for doc build

parent 6bfc94a9
No related branches found
No related tags found
1 merge request!79Swap to sphinx for doc build
Pipeline #74685 passed
stages:
- test
- pages
- deploy
before_script:
- apt-get update --yes
- apt-get install --yes build-essential cmake libfmt-dev pybind11-dev
- apt-get install --yes build-essential cmake libfmt-dev pybind11-dev graphviz
- python -m pip install --upgrade pip
- python --version
- pip install pytest pytest-cov
- pip install pytest pytest-cov sphinx furo numpydoc
- pip install .
- pip show b_asic
......@@ -15,6 +15,7 @@ before_script:
stage: test
script:
- pytest --cov=b_asic --cov-report xml:cov.xml --cov-report term test
- sphinx-build -b html docs_sphinx public
artifacts:
reports:
coverage_report:
......@@ -49,12 +50,13 @@ run-test-qt:
- pip install pytest-xvfb pytest-qt
- pytest --cov=b_asic --cov-report xml:cov.xml --cov-report term test
pages:
pages:
stage: deploy
image: python:3.10
script:
- apt-get install --yes doxygen
- doxygen
- cp -r doc/html public
- sphinx-build -b html docs_sphinx public
artifacts:
paths:
- public
only:
- master
This diff is collapsed.
"""B-ASIC Schedule Module.
"""
B-ASIC Schedule Module.
Contains the schedule class for scheduling operations in an SFG.
"""
......
**************************
``b_asic.core_operations``
**************************
.. inheritance-diagram:: b_asic.core_operations
:parts: 1
:top-classes: b_asic.graph_component.GraphComponent, b_asic.port.SignalSourceProvider
.. automodule:: b_asic.core_operations
:members:
:undoc-members:
:show-inheritance:
**************************
``b_asic.graph_component``
**************************
.. inheritance-diagram:: b_asic.graph_component
:parts: 1
:top-classes: b_asic.graph_component.GraphComponent
.. automodule:: b_asic.graph_component
:members:
:undoc-members:
:show-inheritance:
.. _api:
API
===
.. toctree::
:maxdepth: 1
core_operations.rst
graph_component.rst
operation.rst
port.rst
schedule.rst
signal.rst
signal_flow_graph.rst
simulation.rst
special_operations.rst
********************
``b_asic.operation``
********************
.. inheritance-diagram:: b_asic.operation
:parts: 1
:top-classes: b_asic.graph_component.GraphComponent, b_asic.port.SignalSourceProvider
.. automodule:: b_asic.operation
:members:
:undoc-members:
***************
``b_asic.port``
***************
.. inheritance-diagram:: b_asic.port
:parts: 1
:top-classes: b_asic.port.Port, b_asic.port.SignalSourceProvider
.. automodule:: b_asic.port
:members:
:undoc-members:
:show-inheritance:
*******************
``b_asic.schedule``
*******************
:mod:`.schedule`
.. automodule:: b_asic.schedule
:members:
:undoc-members:
:show-inheritance:
*******************
``b_asic.signal``
*******************
.. automodule:: b_asic.signal
:members:
:undoc-members:
:show-inheritance:
****************************
``b_asic.signal_flow_graph``
****************************
.. automodule:: b_asic.signal_flow_graph
:members:
:undoc-members:
:show-inheritance:
*********************
``b_asic.simulation``
*********************
.. automodule:: b_asic.simulation
:members:
:undoc-members:
:show-inheritance:
*****************************
``b_asic.special_operations``
*****************************
.. inheritance-diagram:: b_asic.special_operations
:parts: 1
:top-classes: b_asic.graph_component.GraphComponent, b_asic.port.SignalSourceProvider
.. automodule:: b_asic.special_operations
:members:
:undoc-members:
:show-inheritance:
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import shutil
project = 'B-ASIC'
copyright = '2020-2022, Oscar Gustafsson et al'
author = 'Oscar Gustafsson et al'
html_logo = "../logo_tiny.png"
pygments_style = 'sphinx'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.inheritance_diagram',
'sphinx.ext.intersphinx',
'numpydoc',
]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
autodoc_docstring_signature = True
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
}
numpydoc_show_class_members = False
inheritance_node_attrs = dict(fontsize=16)
graphviz_dot = shutil.which('dot')
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'furo'
html_static_path = ['_static']
.. B-ASIC documentation master file, created by
sphinx-quickstart on Fri Sep 2 20:10:06 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to B-ASIC's documentation!
==================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Table of Contents
^^^^^^^^^^^^^^^^^
.. toctree::
:maxdepth: 2
self
api/index
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment