IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

add link to "write the docs", move hosting chapter to home page

Browse Source
This commit is contained in:
Georg Brandl 2014-01-12 12:44:36 +01:00
parent b23f0489f4
commit 9d25862700
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/_templates/index.html vendored
View File

@ -21,7 +21,7 @@
</p> </p>
<ul> <ul>
<li>{%trans%}<b>Output formats:</b> HTML (including Windows HTML Help), LaTeX (for <li>{%trans%}<b>Output formats:</b> HTML (including Windows HTML Help), LaTeX (for
printable PDF versions), Texinfo, manual pages, plain text{%endtrans%}</li> printable PDF versions), ePub, Texinfo, manual pages, plain text{%endtrans%}</li>
<li>{%trans%}<b>Extensive cross-references:</b> semantic markup and automatic links <li>{%trans%}<b>Extensive cross-references:</b> semantic markup and automatic links
for functions, classes, citations, glossary terms and similar pieces of for functions, classes, citations, glossary terms and similar pieces of
information{%endtrans%}</li> information{%endtrans%}</li>
@ -85,7 +85,16 @@
of this documentation, thanks to the Japanese Sphinx user group.{%endtrans%}</p> of this documentation, thanks to the Japanese Sphinx user group.{%endtrans%}</p>
<p>{%trans%}A Japanese book about Sphinx has been published by O'Reilly: <p>{%trans%}A Japanese book about Sphinx has been published by O'Reilly:
<a href="http://www.oreilly.co.jp/books/9784873116488/">Sphinxをはじめよう / <a href="http://www.oreilly.co.jp/books/9784873116488/">Sphinxをはじめよう /
Learning Sphinx</a>:{%endtrans%}</p> Learning Sphinx</a>.{%endtrans%}</p>
<p><img src="{{ pathto("_static/bookcover.png", 1) }}"/></p> <!-- <p><img src="{{ pathto("_static/bookcover.png", 1) }}"/></p> -->
<h2>{%trans%}Hosting{%endtrans%}</h2>
<p>{%trans%}Need a place to host your Sphinx docs?
<a href="http://readthedocs.org">readthedocs.org</a> hosts a lot of Sphinx docs
already, and integrates well with projects' source control. It also features a
powerful built-in search that exceeds the possibilities of Sphinx' JavaScript-based
offline search.{%endtrans%}</p>
{% endblock %} {% endblock %}

13
doc/intro.rst
View File

@ -16,6 +16,10 @@ Though there is support for that kind of docs as well (which is intended to be
freely mixed with hand-written content), if you need pure API docs have a look freely mixed with hand-written content), if you need pure API docs have a look
at `Epydoc <http://epydoc.sf.net/>`_, which also understands reST. at `Epydoc <http://epydoc.sf.net/>`_, which also understands reST.
For a great "introduction" to writing docs in general -- the whys and hows, see
also `Write the docs <http://write-the-docs.readthedocs.org/>`_, written by Eric
Holscher.
Conversion from other systems Conversion from other systems
----------------------------- -----------------------------
@ -66,12 +70,3 @@ Usage
See :doc:`tutorial` for an introduction. It also contains links to more See :doc:`tutorial` for an introduction. It also contains links to more
advanced sections in this manual for the topics it discusses. advanced sections in this manual for the topics it discusses.
Hosting
-------
Need a place to host your Sphinx docs? `readthedocs.org
<http://readthedocs.org>`_ hosts a lot of Sphinx docs already, and integrates
well with projects' source control. It also features a powerful built-in search
that exceeds the possibilities of Sphinx' JavaScript-based offline search.