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 documentation build documentation out of date #379

Closed
mpacer opened this issue Aug 30, 2016 · 7 comments
Closed

Local documentation build documentation out of date #379

mpacer opened this issue Aug 30, 2016 · 7 comments

Comments

@mpacer
Copy link
Member

mpacer commented Aug 30, 2016

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.

@mpacer mpacer changed the title Local build documentation woefully out of date Local documentation build documentation woefully out of date Aug 30, 2016
@mpacer mpacer changed the title Local documentation build documentation woefully out of date Local documentation build documentation out of date Aug 30, 2016
@willingc
Copy link
Member

@michaelpacer The instructions are out of date and written before the use of conda in building on RTD. There is an out of date requirements.txt in the docs directory.

nbconvert is by far the most complicated build that we have. To build locally, I typically create a conda environment using conda env create -f environment.yml and then activate it.

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.

@mpacer mpacer added this to the 5.1 milestone Aug 31, 2016
@mpacer
Copy link
Member Author

mpacer commented Aug 31, 2016

@willingc That sounds like a good plan. I'll put it on the 5.1 milestone then.

@mpacer
Copy link
Member Author

mpacer commented Aug 31, 2016

Also, I don't think that there is an out of date requirements.txt at least not that I can see…this is partly what evinced the extremity of my initial title, as the first line of the docs readme mentioned a file that was clearly not in the directory like it said it was.

mpacer pushed a commit that referenced this issue Aug 31, 2016
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.
@willingc
Copy link
Member

You are absolutely correct that the out of date requirements.txt is no longer in the repo. Sorry! I had completely forgotten that we removed earlier this year in this PR #222 https://github.com/jupyter/nbconvert/pull/222/files

@mpacer mpacer modified the milestones: 5.1, 5.2 Jan 22, 2017
@mpacer mpacer modified the milestones: 5.3, 5.2 May 24, 2017
@mpacer mpacer modified the milestones: 5.3, 5.4 Aug 26, 2017
@takluyver
Copy link
Member

The bit about requirements.txt got fixed - is there anything else to do for this, or can we close it?

@willingc
Copy link
Member

Don't remember. I'm cool with closing if @mpacer agrees.

@blink1073 blink1073 modified the milestones: 5.4, 5.5 Aug 29, 2018
@MSeal
Copy link
Contributor

MSeal commented Apr 23, 2019

Closing ticket as no one has chimed in on other missing out-of-date docs. Please reopen if there's anything still missing.

@MSeal MSeal closed this as completed Apr 23, 2019
@MSeal MSeal removed this from the 5.5 milestone Apr 23, 2019
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

5 participants