-
Notifications
You must be signed in to change notification settings - Fork 77
Fix ReadTheDocs Builds #271
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
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
3bb1fb2
create .readthedocs.yaml
aMahanna db40640
add newline
aMahanna 39ca8cc
update specs.rst
aMahanna c926e1c
update sys path
aMahanna caad62d
fix: lint
aMahanna 68f6f20
update sys path
aMahanna 8879e24
temp: add docs/requirements.txt
aMahanna 15c24f3
temp: autodoc_mock_imports
aMahanna 44da098
remove docs/requirements.txt
aMahanna 56ec1bd
Update conf.py
aMahanna ef3c191
update autodoc_mock_imports
aMahanna c67f1fb
temp: disable sys path
aMahanna 79c7bef
revert last commit
aMahanna d11e422
attempt: undo specs.rst changes
aMahanna 8eb0563
temp: remove `requests` & `urlib3` from autodoc_mock_imports
aMahanna 1012e5d
temp: remove `requests_toolbelt` from `autodoc_mock_imports`
aMahanna 2616ead
reintroduce docs/requirements.txt
aMahanna e8e6215
temp: disable `autodoc_mock_imports`
aMahanna f5c3896
new: `importlib_metadata` in docs/requirements.txt
aMahanna d4cf689
new: `jwt` in `docs/requirements.txt`
aMahanna 0d3ac20
remove: `autodoc_mock_imports`
aMahanna File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Read the Docs configuration file for Sphinx projects | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
|
||
| # Required | ||
| version: 2 | ||
|
|
||
| # Set the OS, Python version and other tools you might need | ||
| build: | ||
| os: ubuntu-22.04 | ||
| tools: | ||
| python: "3.11" | ||
|
|
||
| # Build documentation in the "docs/" directory with Sphinx | ||
| sphinx: | ||
| configuration: docs/conf.py | ||
| # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs | ||
| # builder: "dirhtml" | ||
| # Fail on all warnings to avoid broken references | ||
| fail_on_warning: true | ||
|
|
||
| # Optionally build your docs in additional formats such as PDF and ePub | ||
| # formats: | ||
| # - epub | ||
|
|
||
| # Optional but recommended, declare the Python requirements required | ||
| # to build your documentation | ||
| # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
| python: | ||
| install: | ||
| - requirements: docs/requirements.txt |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| requests_toolbelt | ||
| importlib_metadata | ||
| jwt | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is required to support the sphinx
autodocfunctionality (for example, see the followingno module named 'jwt'error: https://readthedocs.org/projects/python-driver-for-arangodb/builds/21620433/)