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

Switch to using Read the Docs #165

Closed
mikemhenry opened this issue Jul 11, 2023 · 3 comments
Closed

Switch to using Read the Docs #165

mikemhenry opened this issue Jul 11, 2023 · 3 comments
Milestone

Comments

@mikemhenry
Copy link
Contributor

@kntkb @yuanqing-wang @jchodera

I was thinking about switching to using read the docs to host docs.espaloma.org We can use github pages if you rather.

One thing I don't understand for the doc building is download_experiments.sh is this something that is still needed? The script has some issues and doesn't actually work:

https://github.com/choderalab/espaloma/actions/runs/5524363534/jobs/10076565563#step:5:67

2023-07-11 20:15:33 (24.7 MB/s) - ‘typing.ipynb’ saved [6691/6691]

[TerminalIPythonApp] WARNING | Unrecognized alias: 'to', it will have no effect.
[TerminalIPythonApp] WARNING | File 'nbconvert' doesn't exist
mv: cannot stat 'typing.rst': No such file or directory

If the goal is to take those notebooks (why are they on google docs and not in the repo?), remove the outputs, then add them to the documentation, I can setup that pipeline.

Thanks!

@mikemhenry
Copy link
Contributor Author

Pro with RTD: Users can search the docs and we can get a preview of the docs built in the pull request so we can see what it looks like

@yuanqing-wang
Copy link
Member

yuanqing-wang commented Jul 11, 2023 via email

@mikemhenry mikemhenry added this to the 0.3.1 milestone Jul 13, 2023
@ijpulidos
Copy link
Contributor

This one should be solved by #167 . Closing.

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

No branches or pull requests

3 participants