diff --git a/.github/workflows/build_and_upload_conda_packages.yaml b/.github/workflows/build_and_upload_conda_packages.yaml index d0f34f6..0dfb77d 100644 --- a/.github/workflows/build_and_upload_conda_packages.yaml +++ b/.github/workflows/build_and_upload_conda_packages.yaml @@ -8,7 +8,7 @@ on: jobs: conda_deployment_with_new_tag: - name: Conda deployment of package to platform ${{ matrix.platform }} with Python ${{ matrix.python-version }} + name: Conda deployment of package to platform with Python ${{ matrix.python-version }} runs-on: ubuntu-latest strategy: fail-fast: false # do not cancel all in-progress jobs if any job variation fails diff --git a/devtools/requirements.yaml b/devtools/requirements.yaml index 2852516..9529fb0 100644 --- a/devtools/requirements.yaml +++ b/devtools/requirements.yaml @@ -34,6 +34,8 @@ docs: - sphinx - sphinx_rtd_theme - sphinxcontrib-bibtex + - sphinx-remove-toctrees + - sphinx-copybutton - myst-nb - openmm - unyt @@ -58,4 +60,3 @@ conda-build: - conda-build - boa - diff --git a/docs/conf.py b/docs/conf.py index 15a8905..1021e51 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,9 +62,22 @@ 'sphinx.ext.githubpages', 'sphinxcontrib.bibtex', 'sphinx.ext.extlinks', + 'sphinx_remove_toctrees', + 'sphinx_copybutton', 'myst_nb' ] +# Myst extensions and options + +myst_enable_extensions = [ + 'dollarmath', + 'amsmath' +] + +myst_heading_anchors = 3 + +# Autosummary options + autosummary_generate = True # Napoleon settings @@ -118,6 +131,12 @@ # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'default' +# Remove from toctrees +remove_from_toctrees = [] +for directory in os.walk('api'): + if directory[0].endswith('/autosummary'): + remove_from_toctrees.append(directory[0]+'/*') + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for