HackerReposA FIELD GUIDE TO OPEN SOURCE
ProSponsor the shelf♧ 0
← Back to top all-time
deceze
Sphinx-HTTP-domain
Python2011–2017
deceze / Sphinx-HTTP-domain

Sphinx-HTTP-domain

Sphinx domain to mark up RESTful web services in ReST.

2Distinct people
2Mentions
0Explicit recommenders
75GitHub stars
REPOSITORY AT A GLANCE

What to know before exploring

What it is

Sphinx domain to mark up RESTful web services in ReST.

GitHub

Where it is used

No documented product use has been verified yet.

What people are saying

No recommendation phrase was found in the indexed comments.

No classified warning is attached to this page. Read the discussions before treating silence as approval.

Also in these discussions

No other repository is repeatedly linked in the same discussions.

This week on Hacker News

Nov 7–Nov 14 UTC · Direct repository links and separately labeled related project stories. Indexed through 11/14/2026, 3:03:16 PM UTC.

No direct repository links were found in the indexed HN discussions over the past seven days. Older discussions are available below.

Mentions over time

HN mentions by year2 dated mentions

Observed mentions: 2011-06-07 16:08:33 UTC to 2017-07-18 08:50:48 UTC.

012011-01-01 00:00:00 UTC to 2012-01-01 00:00:00 UTC (exclusive): 1 mentions; 0 submissions, 1 comments20112012-01-01 00:00:00 UTC to 2013-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments2013-01-01 00:00:00 UTC to 2014-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments2014-01-01 00:00:00 UTC to 2015-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments20142015-01-01 00:00:00 UTC to 2016-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments2016-01-01 00:00:00 UTC to 2017-01-01 00:00:00 UTC (exclusive): 0 mentions; 0 submissions, 0 comments2017-01-01 00:00:00 UTC to 2018-01-01 00:00:00 UTC (exclusive): 1 mentions; 0 submissions, 1 comments2017

Counts come from the repository’s dated source evidence. Index cutoff: 2026-11-02 08:16:59 UTC.

View mention counts and date ranges
UTC ranges include their start and exclude their end. Select a period to filter the source evidence.
PeriodStart (UTC)End (exclusive, UTC)MentionsSubmissionsComments
20112011-01-01 00:00:00 UTC2012-01-01 00:00:00 UTC101
20122012-01-01 00:00:00 UTC2013-01-01 00:00:00 UTC000
20132013-01-01 00:00:00 UTC2014-01-01 00:00:00 UTC000
20142014-01-01 00:00:00 UTC2015-01-01 00:00:00 UTC000
20152015-01-01 00:00:00 UTC2016-01-01 00:00:00 UTC000
20162016-01-01 00:00:00 UTC2017-01-01 00:00:00 UTC000
20172017-01-01 00:00:00 UTC2018-01-01 00:00:00 UTC101

What Hacker News says

2 sources
Documentation Utilities (aka Docutils): http://docutils.sourceforge.net/. Allows reStructuredText markup, programming of custom "roles" and "directives", HTML and PDF creation Sphinx Doc: http://www.sphinx-doc.org/en/stable/. Builds on top of Docutils. Allows API documentation (http://www.sphinx-doc.org/en/stable/ext/autodoc.html) and cross-documentation linking via intersphinx (http://www.sphinx-doc.org/en/stable/ext/intersphinx.html). epub, PDF, and html output. I've created mini technical manuals at previous workplaces using sphinx. More clickables: For graphs, grab aafig: https://pythonhosted.org/sphinxcontrib-aafig/ or graphviz http://www.sphinx-doc.org/en/stable/ext/graphviz.html For enhanced python documentation (numpy and google style api docs) http://www.sphinx-doc.org/en/stable/ext/napoleon.html For creating your own API docs o
Read the rest
In Ask HN: Your favorite technical document writing application
Well, here's a cool plugin I've been using lately: https://github.com/deceze/Sphinx-HTTP-domain For documenting code, Sphinx has the advantage that you can use it for cool stuff like testing the sample code provided. See here: http://sphinx.pocoo.org/ext/doctest.html But you won't get away with just docstrings. Good documentation also includes a high-level overview of the API, history of changes, a glossary of terms, etc... It does have a slight learning curve, but it is very extensible while providing enough out-of-the-box already, and some people have been using it to write entire books.
In Django REST framework with admin-style browseable self-documenting API

MAKE YOURSELF AT HOME

A few shortcuts

/
Search the collection
?
Open this guide
Esc
Close dialogs and navigation

Your saved repositories and interests stay in this browser.