diff --git a/.github/workflows/pr-checks.yml b/.github/workflows/pr-checks.yml index 49b30be2..8df4054f 100644 --- a/.github/workflows/pr-checks.yml +++ b/.github/workflows/pr-checks.yml @@ -37,6 +37,7 @@ jobs: check-docs: name: Check docs for warnings runs-on: ubuntu-latest + continue-on-error: true steps: - uses: actions/checkout@v4 - name: Initialize the environment diff --git a/docs/source/conf.py b/docs/source/conf.py index 94b60730..eeb44e80 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,7 +13,7 @@ import gemd import os import sys -sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath('../../gemd')) # -- Project information ----------------------------------------------------- @@ -36,7 +36,8 @@ extensions = [ 'sphinxcontrib.apidoc', 'sphinx.ext.napoleon', - 'sphinx.ext.intersphinx' + 'sphinx.ext.intersphinx', + 'sphinx_rtd_theme' ] # Use the sphinxcontrib.apidoc extension to wire in the sphinx-apidoc invocation @@ -48,7 +49,6 @@ apidoc_output_dir = 'reference' apidoc_excluded_paths = ['tests', '*impl*'] apidoc_separate_modules = True -apidoc_toc_file = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/source/index.rst b/docs/source/index.rst index a49d07df..23b4f7c8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,7 +26,7 @@ or a specific version can be installed, for example: .. code:: bash - pip install gemd==1.17.1 + pip install gemd==2.1.1 Table of Contents ----------------- @@ -37,6 +37,7 @@ Table of Contents depth/unit_parsing depth/serialization + API Reference Indices ------------------ @@ -44,8 +45,3 @@ Indices * :ref:`genindex` * :ref:`modindex` * :ref:`search` - -.. toctree:: - :maxdepth: 1 - - reference/gemd