search

pybamm-team / pybamm-eis

https://pybamm-eis.readthedocs.io/
MIT License
11 stars 2 forks source link

Host docs to readthedocs #14

Closed arjxn-py closed 2 months ago

arjxn-py commented 2 months ago

Hosts documentation on readthedocs. Should fix #10

arjxn-py commented 2 months ago

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

rtimms commented 2 months ago

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 commented 2 months ago

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)

rtimms commented 2 months ago

great, thanks, @arjxn-py !