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

Restructure docs #178

Merged
merged 4 commits into from
Aug 16, 2021
Merged

Restructure docs #178

merged 4 commits into from
Aug 16, 2021

Conversation

rabernat
Copy link
Contributor

@rabernat rabernat commented Aug 4, 2021

This restructures the docs in line with pangeo-forge/pangeo-forge-vue-website#8 and pangeo-forge/roadmap#25.

It's not complete...some things need to be filled in. But it gives us a place to put the new content.

cc @cisaacstern @rwegener2

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@rwegener2
Copy link
Member

Thanks for getting this rolling @rabernat. I was hoping to view the changes by building and running the sphinx docs locally. Would you be able to briefly share how you do that? The sphinx docs explain some build and run commands, but I'm wondering about environment. I don't see an environment file but I do see the Dockerfile. Is there a docker-compose command you' typically use? Thank you!

@rabernat
Copy link
Contributor Author

rabernat commented Aug 9, 2021

I was hoping to view the changes

One option is to use the RTD preview build:

image

https://pangeo-forge--178.org.readthedocs.build/en/178/

...by building and running the sphinx docs locally.

This is a bit more involved. We need to create some developer documentation which explains how to do this. The basic steps are

  • Clone this repo
  • Create a new, empty virtual environment, e.g. conda create -n pangeo-forge-docs python=3.9
  • Install the doc requirements, e.g. pip install -r ./docs/requirements.txt
  • Build the docs: doc docs; make html
  • Preview the docs: cd _build/html; python -m http.server

Copy link
Member

@cisaacstern cisaacstern left a comment

Choose a reason for hiding this comment

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

This is awesome, Ryan.

My only suggestion is that we point the repo link to the Pangeo Forge org, rather than the recipes repo. And accordingly, maybe we should remove the extlinks, and to set use_issues_button == False?

@rabernat
Copy link
Contributor Author

My only suggestion is that we point the repo link to the Pangeo Forge org, rather than the recipes repo

I see your point, but those changes will break several current features. Despite the more general nature of the documentation, it is useful to have these links point to the actual github repo where the documentation lives, which is still this repo. Let's leave as is for now.

@rabernat rabernat merged commit 49997cb into pangeo-forge:master Aug 16, 2021
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.

3 participants