Skip to content

Remove documentation build bugs #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jan 31, 2024
Prev Previous commit
Next Next commit
PR feedback
  • Loading branch information
kroenlein committed Jan 9, 2024
commit 15c174abe5f9f010b0399f8824918540b57b877f
14 changes: 12 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
apidoc_module_dir = '../../gemd'
apidoc_output_dir = 'reference'
apidoc_excluded_paths = ['tests']
apidoc_separate_modules = True
apidoc_separate_modules = False
apidoc_toc_file = False

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -88,5 +88,15 @@
}

suppress_warnings = [
'ref'
# 'app',
# 'autosectionlabel',
# 'download',
# 'epub',
# 'i18n',
# 'index',
# 'image',
# 'ref',
'ref.python'
# 'misc',
# 'toc'
]
2 changes: 1 addition & 1 deletion docs/source/depth/unit_parsing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ as originally reported, thus creating a potential source of error during the inp

Requests for support of additional units can be made by opening an issue in the `gemd-python repository`_ on github.

.. _Pint: https://pint.readthedocs.io/en/stable/
.. _Pint: https://pint.readthedocs.io/en/0.20/
.. _citrine_en.txt: https://github.com/CitrineInformatics/gemd-python/blob/main/gemd/units/citrine_en.txt
.. _GEMD-python repository: https://github.com/CitrineInformatics/gemd-python
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ Installation

The latest release can be installed via `pip`:

.. code::
.. code:: bash

pip install gemd

or a specific version can be installed, for example:

.. code::
.. code:: bash

pip install gemd==1.0.0
pip install gemd==1.17.1

Table of Contents
-----------------
Expand Down
2 changes: 1 addition & 1 deletion gemd/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.17.1"
__version__ = "1.17.2"