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

Host docs to readthedocs #14

Merged
merged 13 commits into from
Jun 25, 2024
Merged

Conversation

arjxn-py
Copy link
Member

Hosts documentation on readthedocs.
Should fix #10

@arjxn-py
Copy link
Member Author

arjxn-py commented Jun 25, 2024

Docs are building here : https://pybamm-eis.readthedocs.io/en/latest/
Prettification remains.

@rtimms
Copy link
Collaborator

rtimms commented Jun 25, 2024

awesome, thanks! just need to fix conflicts with the optional dependencies (literally merged #12 just as this opened)

let's merge this and worry about making it pretty later. can you also update the readme to point to the docs?

@arjxn-py
Copy link
Member Author

awesome, thanks! just need to fix conflicts with the optional dependencies (literally merged #12 just as this opened)

let's merge this and worry about making it pretty later. can you also update the readme to point to the docs?

Thanks for adding the tests @rtimms, so sorry that it took me more time than expected.
I've resolved the dependency conflicts, in addition to that we also have to note that currently readthedocs is building from my fork's arjxn-py:10-host-readthedocs branch so I'd update hosting too on readthedocs so that it builds from the main branch of upstream once this is merged (as .readthedocs.yaml was required to build so I just chose my fork for testing)

@@ -1,8 +1,11 @@
# PyBaMM EIS
PyBaMM EIS rapidly calculates the electrochemical impedance of any battery model defined using PyBaMM.

PyBaMM EIS rapidly calculates the electrochemical impedance of any battery model defined using PyBaMM, see [the documentation](https://pybamm-eis.readthedocs.io/en/latest/)
Copy link
Member Author

Choose a reason for hiding this comment

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

I've pointed to the docs here
I can also add this badge that is also pointing to the docs -
Documentation Status

@rtimms
Copy link
Collaborator

rtimms commented Jun 25, 2024

great, thanks, @arjxn-py !

@rtimms rtimms merged commit 3f007a1 into pybamm-team:main Jun 25, 2024
2 checks passed
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.

Host readthedocs
2 participants