Skip to content

Commit

Permalink
docs: Fix readthedocs build (#154)
Browse files Browse the repository at this point in the history
* docs: trying to fix rtd build

* update docs config

* style: [pre-commit.ci] auto fixes [...]

* fix path

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
tlambert03 and pre-commit-ci[bot] authored Nov 11, 2022
1 parent daea82a commit c13870b
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 16 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,4 @@ src/ome_types/model/
src/ome_types/_version.py
docs/source/_autosummary
.benchmarks/
_build/
12 changes: 8 additions & 4 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,19 @@
# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py


# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: docs/requirements.txt
- method: setuptools
- method: pip
path: .
extra_requirements:
- docs
11 changes: 0 additions & 11 deletions docs/requirements.txt

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import os
import sys

sys.path.insert(0, os.path.abspath("../../src"))
sys.path.insert(0, os.path.abspath("../../"))
from ome_types import __version__ # isort:skip # noqa


Expand Down
9 changes: 9 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,15 @@ autogen =
black
isort>=5.0
numpydoc
docs =
autoflake
black
ipython
isort>=5.0
numpydoc
pygments
sphinx==5.3.0
sphinx-rtd-theme==1.1.1
test =
pytest
pytest-benchmark
Expand Down
1 change: 1 addition & 0 deletions src/ome_types/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"to_xml",
"ureg",
"validate_xml",
"__version__",
]


Expand Down

0 comments on commit c13870b

Please sign in to comment.