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

Add commands to the 'Writing Documentation' section #2086

Closed
decentral1se opened this issue Nov 26, 2016 · 1 comment
Closed

Add commands to the 'Writing Documentation' section #2086

decentral1se opened this issue Nov 26, 2016 · 1 comment

Comments

@decentral1se
Copy link
Contributor

decentral1se commented Nov 26, 2016

On the Write documentation section, I couldn't find exactly how to get started easily.

I was able to find out what I need to do:

$ tox -e docs
$ firefox doc/en/_build/index.html

Then I could check my changes locally. I think it might be nice to add a note in the 'Writing documentation' section for those commands, especially for people not used to working with tox/sphinx/looking in the setup.cfg.

Or it's written somewhere else?

I'll submit a PR if that is useful 🍻

@nicoddemus
Copy link
Member

I'll submit a PR if that is useful

Yes please! We have decided for tox -e docs to be the official command for building documentation locally but never got around to write it somewhere.

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

2 participants