-
Notifications
You must be signed in to change notification settings - Fork 32
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
Convert the documentation from Lore to Sphinx #40
Conversation
# built documents. | ||
# | ||
# The short X.Y version. | ||
version = '11.1' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally, the version number would not be duplicated here (9/10ths of the motivation for switching to github was to get rid of the duplicate version number in setup.py
, I'd really like to not immediately re-introduce the duplication in another place).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is duplicating the few lines from setup.py
a sufficient fix?
I'm inclined to merge this, but could you add build automation so I can see travis is happy with the docs and will build them? If you'd strongly prefer to put that in a separate PR I will merge. |
@glyph I'm going to push some commits so I'm sure the Travis configuration is OK, I'll let you know when I think it's ready to merge. |
Mostly done automatically with the help of html2markdown piped into pandoc to produce reStructured Text Links between documents have been manually fixed though.
9bb460a
to
b7100c0
Compare
@glyph I added a requirements into the It's not as nice as I want it to be though, AFAIK pip doesn't know how to handle installing these extras from a file or from There are other possibilities to install Sphinx though:
Maybe you have another suggestion? |
Sphinx is not a dependency of Nevow; at no point does Nevow need to import it. So I am not worried that we would potentially be encoding dependency information in multiple places. Accordingly, I think that we should not actually install However, for a first cut I think this is good enough. Lore has already gone away, so we need to move quickly to adapt to the changing environment in which Nevow exists. I'm going to create a couple of issues and assign them to you. |
Convert the documentation from Lore to Sphinx
It's not great, I'm not sure how to exactly convert the more "prose" style of the old documentation to the more "automated" way of linking documents together by Sphinx.
Still, it's pretty good I guess, it should fix #20 and allow with some more help to fix #21 as well.