Skip to content
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

Fix docs builds #319

Merged
merged 5 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
version: 2

build:
os: ubuntu-20.04
tools:
python: "mambaforge-4.10"

python:
install:
- method: pip
path: .

conda:
environment: devtools/conda-envs/docs.yaml

sphinx:
configuration: docs/conf.py
fail_on_warning: false

formats:
- pdf
14 changes: 0 additions & 14 deletions .readthedocs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion devtools/conda-envs/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ dependencies:
- setuptools

# Sphinx specific
- sphinx >=4.4,<5.0
- sphinx =6
- nbsphinx
- nbsphinx-link
- sphinx_rtd_theme
Expand Down
39 changes: 9 additions & 30 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Below is an outline of the API for ``openff-qcsubmit``. See the examples for det
.. warning:: The ``openff-qcsubmit`` package is still pre-alpha, so the API is still in flux.

Datasets
--------
""""""""

.. currentmodule:: openff.qcsubmit.datasets
.. autosummary::
Expand All @@ -21,8 +21,6 @@ Datasets
TorsionDriveEntry
FilterEntry

.. _factories:

Factories
"""""""""

Expand Down Expand Up @@ -65,7 +63,7 @@ Constraints
PositionConstraintSet

Results
-------
"""""""

.. currentmodule:: openff.qcsubmit.results
.. autosummary::
Expand All @@ -79,8 +77,8 @@ Results
TorsionDriveResult
TorsionDriveResultCollection

Filters
"""""""
Results Filters
"""""""""""""""

.. currentmodule:: openff.qcsubmit.results.filters
.. autosummary::
Expand All @@ -89,8 +87,6 @@ Filters

ResultFilter
CMILESResultFilter
ResultRecordFilter
ResultRecordGroupFilter
SMILESFilter
SMARTSFilter
ChargeFilter
Expand All @@ -103,25 +99,9 @@ Filters
ConformerRMSDFilter
MinimumConformersFilter

Caching
"""""""

.. currentmodule:: openff.qcsubmit.results.caching
.. autosummary::
:nosignatures:
:toctree: api/generated/

clear_results_caches
batched_indices
cached_fractal_client
cached_query_procedures
cached_query_molecules
cached_query_basic_results
cached_query_optimization_results
cached_query_torsion_drive_results

Workflow Components
-------------------
"""""""""""""""""""

.. currentmodule:: openff.qcsubmit.workflow_components
.. autosummary::
Expand Down Expand Up @@ -183,7 +163,7 @@ State Enumeration
ScanEnumerator

Workflow Utilities
"""""
""""""""""""""""""

.. currentmodule:: openff.qcsubmit.workflow_components
.. autosummary::
Expand All @@ -201,7 +181,7 @@ Workflow Utilities
TorsionIndexer

Common Structures
-----------------
"""""""""""""""""

.. currentmodule:: openff.qcsubmit.common_structures
.. autosummary::
Expand All @@ -216,14 +196,13 @@ Common Structures
QCSpec
QCSpecificationHandler
IndexCleaner
ClientHandler
Metadata
MoleculeAttributes
SCFProperties
CommonBase

Utilities
---------
"""""""""

.. currentmodule:: openff.qcsubmit.utils
.. autosummary::
Expand All @@ -234,7 +213,7 @@ Utilities
portal_client_manager

Exceptions
----------
""""""""""

.. currentmodule:: openff.qcsubmit.exceptions
.. autosummary::
Expand Down
17 changes: 10 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
import os
import sys

import openff.qcsubmit

sys.path.insert(0, os.path.abspath(os.pardir))


Expand All @@ -25,9 +27,9 @@
author = "Open Force Field Consortium"

# The short X.Y version
version = ""
version = openff.qcsubmit.__version__
# The full version, including alpha/beta/rc tags
release = ""
release = openff.qcsubmit.__version__


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -100,11 +102,12 @@
"https://open-forcefield-toolkit.readthedocs.io/en/latest/",
None,
),
"qcportal": ("http://docs.qcarchive.molssi.org/projects/qcportal/en/latest/", None),
"qcelemental": (
"http://docs.qcarchive.molssi.org/projects/qcelemental/en/latest/",
None,
),
# Broken
# "qcportal": ("http://docs.qcarchive.molssi.org/projects/qcportal/en/latest/", None),
# "qcelemental": (
# "http://docs.qcarchive.molssi.org/projects/qcelemental/en/latest/",
# None,
# ),
"openff.docs": (
"https://docs.openforcefield.org/en/latest/",
None,
Expand Down