-
Notifications
You must be signed in to change notification settings - Fork 572
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 documentation build documentation out of date #379
Comments
@michaelpacer The instructions are out of date and written before the use of conda in building on RTD. There is an out of date nbconvert is by far the most complicated build that we have. To build locally, I typically create a conda environment using Let's work together over the next couple of weeks to refine the instructions for building locally and on RTD and cobble together a short screencast/webcast specific to nbconvert. |
@willingc That sounds like a good plan. I'll put it on the 5.1 milestone then. |
Also, I don't think that there is an out of date |
Pursuant to #379, this seemed like a good thing to make as a quick fix, with the more substantial restructuring to occur later. Notably this requires using conda, which not all users may rely on. I do not know if there is a way to expose the `environment.yml` file to a `pip` command for non-conda users, but it seems like it shouldn't be a long run requirement that you use `conda` in order to build our docs.
You are absolutely correct that the out of date |
The bit about |
Don't remember. I'm cool with closing if @mpacer agrees. |
Closing ticket as no one has chimed in on other missing out-of-date docs. Please reopen if there's anything still missing. |
The second instruction states to build the docs using a
requirements.txt
file that does not currently exist.Right now there's an error due to the use of a bdist_egg based on however the docs are being built currently, which I have yet to suss out.
The text was updated successfully, but these errors were encountered: