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

Basic doc updates #7

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Basic doc updates #7

wants to merge 3 commits into from

Conversation

Rukkh
Copy link

@Rukkh Rukkh commented May 18, 2015

Tidied up the issue identified with the links to python modules.

Tweaked a few other things to make Sphinx happy (probably could have ignored warnings but was a good exercise in learning reST, Sphinx etc. (Also git)

Happy to do some bigger doc updates, but don't want to dive in too deep if you have other plans for the documentation.

Blake

Rukkh added 3 commits May 18, 2015 22:31
Added some help for using pip to install as an alternative to apt-get
Sphinx default template name changed, name changed to keep consistent with existing doco
@m-mcgowan
Copy link

Many thanks for this @Rukkh! All looks good. Can you tell me about the change of the theme from "deafult" to "classic"?

@Rukkh
Copy link
Author

Rukkh commented May 22, 2015

http://sphinx-doc.org/theming.html

The theme the brewpi user docs are using are the original 'default' theme based off the python documentation look. At some point it looks like Sphinx has changed the 'default' theme to the alabaster one based off the ReadTheDocs.com theme and they've renamed 'default' to 'classic'.
When you leave 'default' in there sphinx gives you a warning that the 'default' has changed. I think that it still gives you the same theme output but i guess there's a risk in the future they make the 'default' named theme the other one.

I'm just a little bit conditioned to react to unnecessary compiler output warnings.

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.

2 participants