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

Local docs don't see the package itself? #48

Closed
navidcy opened this issue Jun 22, 2023 · 2 comments · Fixed by #49
Closed

Local docs don't see the package itself? #48

navidcy opened this issue Jun 22, 2023 · 2 comments · Fixed by #49
Labels
documentation 📔 Improvements or additions to documentation

Comments

@navidcy
Copy link
Contributor

navidcy commented Jun 22, 2023

So following the directions at https://regional-mom6.readthedocs.io/en/latest/contributing.html#documentation to build the docs locally the API website is empty.

Seems like the docs don't see the package itself? If I do pip install ../. then it works; but every time I edit a docstring I need to re-install? Somehow I'd expect (intuitively) that sphinx would be able to monitor changes in the package itself? Am I doing something wrong or that's how it is?

(Because the docs are not built via a Github Action I don't know exactly what's the pipeline for building them...)

cc @angus-g

@angus-g
Copy link
Collaborator

angus-g commented Jun 22, 2023

You need to do an editable install with pip install -e ., otherwise the installed version is essentially a snapshot of what was in the repo at the time you did install.

@navidcy navidcy added the documentation 📔 Improvements or additions to documentation label Jun 22, 2023
@navidcy
Copy link
Contributor Author

navidcy commented Jun 22, 2023

Gotcha!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📔 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants