Skip to content

docs: fix RTD timeout issue #3694

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 8 commits into from
Apr 20, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
34 changes: 4 additions & 30 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,36 +32,9 @@
copyright = "2017-%d, DeepModeling" % date.today().year
author = "DeepModeling"


def run_apidoc(_):
import sys

from sphinx.ext.apidoc import (
main,
)

sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
cur_dir = os.path.abspath(os.path.dirname(__file__))
module = os.path.join(cur_dir, "..")
main(
[
"-M",
"--tocfile",
"api_py",
"-H",
"Python API",
"-o",
os.path.join(cur_dir, "api_py"),
module,
"source/*",
"--force",
]
)


def setup(app):
# Add hook for building doxygen xml when needed
app.connect("builder-inited", run_apidoc)
extensions = ["autoapi.extension"]
autoapi_dirs = ["../deepmd"]
autoapi_add_toctree_entry = False


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -94,6 +67,7 @@
"exhale",
"sphinxcontrib.bibtex",
"sphinx_design",
"autoapi.extension",
]

# breathe_domain_by_extension = {
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ DeePMD-kit is a package written in Python/C++, designed to minimize the effort r
development/type-embedding
development/coding-conventions
development/cicd
api_py/api_py
autoapi/deepmd/index
api_op
API_CC/api_cc
api_c/api_c
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ docs = [
"sphinx-argparse",
"pygments-lammps",
"sphinxcontrib-bibtex",
"sphinx-autoapi",
]
lmp = [
"lammps~=2023.8.2.3.0",
Expand Down
Loading