PageRenderTime 51ms CodeModel.GetById 48ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

/Doc/documenting/index.rst

Relevant Search: With Applications for Solr and Elasticsearch

For more in depth reading about search, ranking and generally everything you could ever want to know about how lucene, elasticsearch or solr work under the hood I highly suggest this book. Easily one of the most interesting technical books I have read in a long time. If you are tasked with solving search relevance problems even if not in Solr or Elasticsearch it should be your first reference. Amazon Affiliate Link
http://unladen-swallow.googlecode.com/
ReStructuredText | 32 lines | 24 code | 8 blank | 0 comment | 0 complexity | 04e4366b002f2cecae3e53cf677ca734 MD5 | raw file
 1.. _documenting-index:
 2
 3######################
 4  Documenting Python
 5######################
 6
 7
 8The Python language has a substantial body of documentation, much of it
 9contributed by various authors. The markup used for the Python documentation is
10`reStructuredText`_, developed by the `docutils`_ project, amended by custom
11directives and using a toolset named `Sphinx`_ to postprocess the HTML output.
12
13This document describes the style guide for our documentation, the custom
14reStructuredText markup introduced to support Python documentation and how it
15should be used, as well as the Sphinx build system.
16
17.. _reStructuredText: http://docutils.sf.net/rst.html
18.. _docutils: http://docutils.sf.net/
19.. _Sphinx: http://sphinx.pocoo.org/
20
21If you're interested in contributing to Python's documentation, there's no need
22to write reStructuredText if you're not so inclined; plain text contributions
23are more than welcome as well.
24
25.. toctree::
26   :numbered:
27
28   intro.rst
29   style.rst
30   rest.rst
31   markup.rst
32   fromlatex.rst