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.

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

docs: Add RTD config #894

Merged
merged 1 commit into from Sep 16, 2022
Merged

Conversation

colin-pm
Copy link
Member

Upgrading to Poetry broke RTD's ability to build the docs.

Adds Readthedocs config file to properly build documentation.

Signed-off-by: Colin McAllister colinmca242@gmail.com

@colin-pm colin-pm requested a review from a team as a code owner September 16, 2022 14:22
@colin-pm colin-pm linked an issue Sep 16, 2022 that may be closed by this pull request
@colin-pm colin-pm added bug documentation documentation updates and/or requests for expanded documentation labels Sep 16, 2022
Upgrading to Poetry broke RTD's ability to build the docs.

Adds Readthedocs config file to properly build documentation along with a requirements.txt file for RTD to parse.

The RTD file can probably be removed once we get all packages up to date after dropping 3.6.

Signed-off-by: Colin McAllister <colinmca242@gmail.com>
@colin-pm
Copy link
Member Author

I tested this locally on my fork with readthedocs and everything seems to be working.
https://readthedocs.org/projects/hvac-test/builds/18092848/

@briantist briantist added this to the 1.0.1 milestone Sep 16, 2022
@colin-pm colin-pm merged commit 2eae41d into hvac:develop Sep 16, 2022
@colin-pm colin-pm deleted the feature/add_rtd_config branch September 16, 2022 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation documentation updates and/or requests for expanded documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

readthedocs documentation is outdated
2 participants