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

Convert the documentation from Lore to Sphinx #40

Merged
merged 7 commits into from
Nov 27, 2014

Conversation

multani
Copy link
Member

@multani multani commented Jun 22, 2014

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.

# built documents.
#
# The short X.Y version.
version = '11.1'
Copy link
Member

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).

Copy link
Member Author

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?

@glyph
Copy link
Member

glyph commented Nov 26, 2014

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.

@multani
Copy link
Member Author

multani commented Nov 26, 2014

@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.
@multani multani force-pushed the sphinx-doc branch 2 times, most recently from 9bb460a to b7100c0 Compare November 26, 2014 14:28
@multani
Copy link
Member Author

multani commented Nov 26, 2014

@glyph I added a requirements into the doc extra requirements list and changed the Travis configuration accordingly, and he seems to be happy with that.

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 . in non-editable mode.

There are other possibilities to install Sphinx though:

  • install it once and for all at the beginning of Travis' install phase, but then we'll miss the fact that it's a dependency required to build the doc (we actually already miss it except in the inplace mode)
  • add a requirements.txt file which is then installed by pip at the beginning of Travis. It's more or less the same as before except that the dependency is encoded outside of Travis, it might be better. But it means there are still 2 places to lookup for dependencies (the setup.py and the requirements.txt)

Maybe you have another suggestion?

@glyph
Copy link
Member

glyph commented Nov 27, 2014

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 Sphinx into the test environments; if Nevow did start importing Sphinx, that would be a bug :).

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.

glyph added a commit that referenced this pull request Nov 27, 2014
Convert the documentation from Lore to Sphinx
@glyph glyph merged commit 4c5d418 into twisted:master Nov 27, 2014
@multani multani deleted the sphinx-doc branch November 27, 2014 09:22
@multani multani mentioned this pull request Dec 5, 2014
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.

Set up readthedocs.org Convert documentation to Sphinx
3 participants