TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Hosting Sphinx documentation on GitHub

34 pointsby palewireover 13 years ago
Quickly publish documentation alongside your code by following this easy recipe.

2 comments

Adaptiveover 13 years ago
This is a meta comment but I think others might have the same reaction: LA Times? Nice to see something other than "what digital camera you should buy this month" in a technology column from a traditional/transitioning media company.<p>Indeed: a regular column devoted to "maps, databases and visualization". Between this and the NYT's work and writing about information graphics and data mining, the "newspaper" segment of traditional media seems to be among the most innovative.
评论 #3420442 未加载
评论 #3420333 未加载
评论 #3420327 未加载
masklinnover 13 years ago
An alternative is to host the documentation on readthedocs[0] instead: rtfd is dedicated to hosting sphinx documentations so it'll build the documentation on its own, it understands git (and mercurial, and bazaar, and svn) repositories[1] and it provide webhooks to get it to update your documentation on push[2]. In fact, Github has built-in support for rtfd so you only need to check the corresponding option.<p>That way, no need to mess around with committing your (compiled) doc in a separate branch and remembering to push your compiled artifacts.<p>[0] <a href="http://readthedocs.org/" rel="nofollow">http://readthedocs.org/</a><p>[1] <a href="http://read-the-docs.readthedocs.org/en/latest/features.html#version-control-support-matrix" rel="nofollow">http://read-the-docs.readthedocs.org/en/latest/features.html...</a><p>[2] <a href="http://read-the-docs.readthedocs.org/en/latest/webhooks.html" rel="nofollow">http://read-the-docs.readthedocs.org/en/latest/webhooks.html</a>
评论 #3420840 未加载
评论 #3420422 未加载