Skip to content

Commit

Permalink
Install local library when generating docs (#469)
Browse files Browse the repository at this point in the history
## Changes
#467 changed the docs to require the databricks SDK itself to be
installed for Sphinx to generate docs correctly. This PR fixes the
requirements file used by readthedocs.org to install the SDK before
trying to generate docs. The requirements file is consumed from the root
directory by readthedocs.py, so I moved it to the root directory so it's
more obvious that it ought to be run from there.

## Tests
<!-- 
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->

- [ ] `make test` run locally
- [ ] `make fmt` applied
- [ ] relevant integration tests applied
  • Loading branch information
mgyucht authored Dec 1, 2023
1 parent efe5ede commit 9f5b2e7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ sphinx:

python:
install:
- requirements: docs/requirements.txt
- requirements: docs-requirements.txt
1 change: 1 addition & 0 deletions docs/requirements.txt → docs-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ myst_parser
sphinx-autobuild
enum_tools
sphinx-toolbox
.

0 comments on commit 9f5b2e7

Please sign in to comment.