Skip to content

Commit

Permalink
Mic 4180/doc builds (#317)
Browse files Browse the repository at this point in the history
Mic-4180/doc builds

Update for docs to work successfully.
- *Category*: Documentation
- *JIRA issue*: [MIC-4180](https://jira.ihme.washington.edu/browse/MIC-4180)

Changes and notes
-update readthedocs yml
-pin sphinx below 7.0
-update doctest

Testing
Doctest pass and no build failures.
  • Loading branch information
albrja committed Sep 14, 2023
1 parent 5bbf7ad commit 90f5d9d
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 10 deletions.
13 changes: 6 additions & 7 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,9 @@ jobs:
- name: Test
run: |
pytest ./tests
# Commenting out docs build due to upstream failures: MIC-4180
# - name: Doc build
# run: |
# make html -C docs/ SPHINXOPTS="-W --keep-going -n"
# - name: Doctest
# run: |
# make doctest -C docs/
- name: Doc build
run: |
make html -C docs/ SPHINXOPTS="-W --keep-going -n"
- name: Doctest
run: |
make doctest -C docs/
5 changes: 4 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ version: 2

# Configure the python version and environment construction run before
# docs are built.
build:
os: ubuntu-22.04
tools:
python: "3.11"
python:
version: 3.8
install:
# This runs pip install .[docs] from the project root.
- method: pip
Expand Down
7 changes: 6 additions & 1 deletion docs/source/tutorials/pulling_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,12 @@ To use:
from gbd_mapping import ModelableEntity

funcs = {get_measure: {
'parameters': {'entity': ModelableEntity, 'measure': str, 'location': str},
'parameters': {
'entity': ModelableEntity,
'measure': str,
'location': str,
'get_draws_kwargs': inspect._empty,
},
'return': pd.DataFrame, },
get_population_structure: {
'parameters': {'location': str},
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
]

doc_requirements = [
"sphinx>=4.0",
"sphinx<7.0",
"sphinx-rtd-theme",
]

Expand Down

0 comments on commit 90f5d9d

Please sign in to comment.