19 Commits

Author SHA1 Message Date
Tatsuhiro Tsujikawa
a029f6ed2c Rename sphinxcontrib to rubydomain to avoid module loading error
Rename sphinxcontrib to rubydomain to avoid module loading error when
sphinx-build docker image is used.
2021-09-20 13:43:40 +09:00
Tatsuhiro Tsujikawa
9656ac0254 Fix sphinx warnings 2017-10-24 23:10:23 +09:00
Peter Wu
a6effb4d23 doc: fix out-of-tree doc builds
Fixes multiple errors while making docs:

    Could not import extension sphinxcontrib.rubydomain (exception: No module named 'sphinxcontrib')

and

    ../../doc/sources/index.rst:15: WARNING: toctree contains reference to nonexisting document 'nghttp.1'
    ../../doc/sources/index.rst:15: WARNING: toctree contains reference to nonexisting document 'nghttpd.1'
    ../../doc/sources/index.rst:15: WARNING: toctree contains reference to nonexisting document 'nghttpx.1'
    ../../doc/sources/index.rst:15: WARNING: toctree contains reference to nonexisting document 'h2load.1'
    ../../doc/sources/index.rst:15: WARNING: toctree contains reference to nonexisting document 'programmers-guide'
2016-02-13 20:11:50 +01:00
Tatsuhiro Tsujikawa
a7ec90506f Happy new year! 2016-01-09 18:28:38 +09:00
Tatsuhiro Tsujikawa
f0bf2233d2 Remove the word "experimental" since HTTP/2 has been finalized 2015-10-20 00:19:49 +09:00
Tatsuhiro Tsujikawa
18064d1626 Document nghttpx mruby extension 2015-09-05 21:23:27 +09:00
Tatsuhiro Tsujikawa
a3dcf1e004 Produce man pages using sphinx
Previously to create manual page for bundled programs, we use help2man
to create man page from program's help output.  Then our man2rst.py
script converts man page to rst document.  Sphinx generates html from
rst documents.

Now help2rst.py produces rst document from programs output.  We use
Sphinx solely to produce both man pages and html files.
2015-01-10 00:37:42 +09:00
Tatsuhiro Tsujikawa
cfbf907418 doc: Disable smartypants since we use '--' prefix for cmd options 2014-10-18 18:25:37 +09:00
Tatsuhiro Tsujikawa
ab2dc5967d Replace HTTP/2.0 with HTTP/2 2014-03-30 19:26:37 +09:00
Tatsuhiro Tsujikawa
01ca4373a1 Out-of-tree build for sphinx documents
The only drawback is that page source only contains include
directive. We disabled page source for now.
2014-02-13 23:44:54 +09:00
Tatsuhiro Tsujikawa
df0b59cc94 Update copyright year to 2014 2014-01-05 22:17:12 +09:00
Tatsuhiro Tsujikawa
0611768506 doc: Use Read The Docs sphinx theme 2013-12-07 01:27:56 +09:00
Tatsuhiro Tsujikawa
0edce70343 Rebranding nghttp2 2013-07-13 00:43:06 +09:00
Tatsuhiro Tsujikawa
2c3195d300 doc: Update doc theme 2013-03-11 00:29:33 +09:00
Tatsuhiro Tsujikawa
bae80e5667 doc: Specify static file explicitly 2013-02-19 23:34:52 +09:00
Tatsuhiro Tsujikawa
bcf566a2f4 doc: Fix packaging and customize theme 2013-02-02 18:52:09 +09:00
Tatsuhiro Tsujikawa
0c8c6614d7 doc: Move links to sidebar 2013-01-12 17:27:05 +09:00
Tatsuhiro Tsujikawa
7760929153 doc: Update copyright year 2013-01-12 17:08:17 +09:00
Tatsuhiro Tsujikawa
07b02404c3 Added API reference generator script.
Formatted the public APIs with Sphinx syntax.
2012-03-14 00:32:52 +09:00