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

Host docs to readthedocs #14

Merged
merged 13 commits into from
Jun 25, 2024
Prev Previous commit
Next Next commit
Specify deps in docs extra instead
  • Loading branch information
arjxn-py committed Jun 25, 2024
commit ed8925c2e020ca189a6ff9caff03a77926b685d2
14 changes: 7 additions & 7 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ formats:
- epub
- htmlzip

python:
install:
- method: pip
path: .
extra_requirements:
- docs

build:
os: ubuntu-22.04
apt_packages:
Expand All @@ -25,10 +32,3 @@ build:
- cd docs/build/ && latexmk -r latexmkrc -pdf -f -dvi- -ps- -jobname=pybamm-eis -interaction=nonstopmode || true
- test -f docs/build/pybamm-eis.pdf && echo "pybamm-eis.pdf exists. Copying source file to $READTHEDOCS_OUTPUT/pdf/."
- cp "docs/build/pybamm-eis.pdf" $READTHEDOCS_OUTPUT/pdf/

python:
install:
- method: pip
path: .
extra_requirements:
- myst-parser
9 changes: 9 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,12 @@ packages = [
[tool.setuptools.dynamic]
version = {attr = "pbeis.version.__version__"}
readme = {file = ["README.md"], content-type = "text/markdown"}

[project.optional-dependencies]
docs = [
# Sphinx extensions
"sphinx.ext.autodoc",
"sphinx.ext.mathjax",
# Third-party extensions
"myst_parser",
]