Skip to content

Documentation guidelines improvements 2 #7412

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

Closed
choldgraf opened this issue Nov 5, 2016 · 3 comments
Closed

Documentation guidelines improvements 2 #7412

choldgraf opened this issue Nov 5, 2016 · 3 comments
Milestone

Comments

@choldgraf
Copy link
Contributor

choldgraf commented Nov 5, 2016

Hey all - these are some quick issues I ran across when following the documentation guidelines. I can open a PR to fix them later (once I get the docs finally built) but want to make sure all the points I ran into are worth changing:

  1. There are extra dependencies not listed there. In particular a Latex package with at least the package "type1cm". It would be helpful to point people to a latex distribution page if necessary.
  2. When I was trying to build the docs initially I ran into a bunch of weird errors where the answer was usually solved by deleting a folder that is auto-generated by the docs build (e.g. the examples folder w/ the rendered rst files etc). It might be useful to include a quick section like "if something doesn't work and you can't find the answer here, try these steps to see if it fixes things". I'm imagining something like how I tell people "did you turn your computer off and on?" when they have computer problems.
  3. There's a dependency on graphviz. Can't remember if this is documented or not but in case it's not I'm putting this here.

If anything else comes up I can bring it up here, this will serve as a placeholder for my own experience. @NelleV if you can remember anything that came up when we were doing this before then feel free to note here and I can make a change to the docs later on.

@NelleV
Copy link
Member

NelleV commented Nov 7, 2016

Hi @choldgraf
Thanks for keeping track of the problems you have. Do you think you could open a PR to update the documentation?

PS: I don't remember much from our installation attempt at the summit.

@choldgraf
Copy link
Contributor Author

I can open a PR as soon as I can actually build the documentation ;)

@tacaswell tacaswell added this to the 2.0.1 (next bug fix release) milestone Nov 8, 2016
@choldgraf
Copy link
Contributor Author

Closing this because I think we figured these points out in subsequent PRs in the last few months

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants