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

Add readthedocs config file #1165

Merged
merged 3 commits into from
Sep 13, 2020
Merged

Conversation

tlestang
Copy link
Contributor

This adds a .readthedocs.yml at the root of the PyBaMM repo.
This makes configuring Read The Docs easier, without the need to log in to RTD and change the settings there.

This change originates from issue #1164 , caused by the file .requirements-docs not being up to date with the current dependencies.
This file was updated, renamed to docs/requirements.txt and set as the requirement file for readthedocs in .readthedocs.yml.

Fixes #1164

Copy link
Member

@valentinsulzer valentinsulzer left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this @tlestang

@valentinsulzer valentinsulzer merged commit 6726d60 into pybamm-team:develop Sep 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API documentation missing on RTD
2 participants