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.

Sign up for GitHub

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

specify RTD packages #9421

Merged
merged 2 commits into from
Mar 29, 2022
Merged

specify RTD packages #9421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eae549a
specify rtd packages
critesjosh Mar 29, 2022
bf11183
Merge branch 'master' into critesjosh/sdk-docs-build
critesjosh Mar 29, 2022
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
3 changes: 3 additions & 0 deletions packages/docs/sdk/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
jinja2==3.0.0
sphinx==4.2.0
sphinx_rtd_theme==1.0.0
7 changes: 6 additions & 1 deletion readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@ version: 2

mkdocs:
configuration: packages/docs/sdk/mkdocs.yml
fail_on_warning: true
fail_on_warning: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what if we didnt fail on warning?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's an option. seems better to make packages explicit and fail on warnings though, so we can address them as they come up.


# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: packages/docs/sdk/requirements.txt