Permalink
Browse files

improve documentation

  • Loading branch information...
sdpython committed Oct 22, 2016
1 parent b018f7c commit 40ad3b6ca500c5558f5c94a89d3a77127ead2753
Showing with 62 additions and 17 deletions.
  1. +33 −1 _doc/sphinxdoc/source/conf.py
  2. +21 −0 _doc/sphinxdoc/source/end_index.rst
  3. +8 −16 _doc/sphinxdoc/source/index.rst
@@ -26,10 +26,42 @@
"hachibee", hachibee_sphinx_theme.get_html_themes_path(),
locals(), add_extensions=['hachibee_sphinx_theme'],
custom_style='custom_style.css',
extlinks=dict(issue=('https://github.com/sdpython/code_beatrix/issues/%s', 'issue')))
extlinks=dict(issue=('https://github.com/sdpython/code_beatrix/issues/%s', 'issue'),
book=True))
html_show_copyright = False
html_title = "lesenfantcodaient.fr"
language = "fr"
blog_root = "http://lesenfantscodaient.fr/"
custom_preamble = """\n
\\newcommand{\\vecteur}[2]{\\pa{#1,\\dots,#2}}
\\newcommand{\\N}[0]{\\mathbb{N}}
\\newcommand{\\indicatrice}[1]{\\mathbf{1\\!\\!1}_{\\acc{#1}}}
\\usepackage[all]{xy}
\\newcommand{\\infegal}[0]{\\leqslant}
\\newcommand{\\supegal}[0]{\\geqslant}
\\newcommand{\\ensemble}[2]{\\acc{#1,\\dots,#2}}
\\newcommand{\\fleche}[1]{\\overrightarrow{ #1 }}
\\newcommand{\\intervalle}[2]{\\left\\{#1,\\cdots,#2\\right\\}}
\\newcommand{\\loinormale}[2]{{\\cal N}\\pa{#1,#2}}
\\newcommand{\\independant}[0]{\\;\\makebox[3ex]{\\makebox[0ex]{\\rule[-0.2ex]{3ex}{.1ex}}\\!\\!\\!\\!\\makebox[.5ex][l]{\\rule[-.2ex]{.1ex}{2ex}}\\makebox[.5ex][l]{\\rule[-.2ex]{.1ex}{2ex}}} \\,\\,}
\\newcommand{\\esp}{\\mathbb{E}}
\\newcommand{\\var}{\\mathbb{V}}
\\newcommand{\\pr}[1]{\\mathbb{P}\\pa{#1}}
\\newcommand{\\loi}[0]{{\\cal L}}
\\newcommand{\\vecteurno}[2]{#1,\\dots,#2}
\\newcommand{\\norm}[1]{\\left\\Vert#1\\right\\Vert}
\\newcommand{\\dans}[0]{\\rightarrow}
\\newcommand{\\partialfrac}[2]{\\frac{\\partial #1}{\\partial #2}}
\\newcommand{\\partialdfrac}[2]{\\dfrac{\\partial #1}{\\partial #2}}
\\newcommand{\\loimultinomiale}[1]{{\\cal M}\\pa{#1}}
\\newcommand{\\trace}[1]{tr\\pa{#1}}
\\newcommand{\\abs}[1]{\\left|#1\\right|}
"""
#\\usepackage{eepic}
imgmath_latex_preamble += custom_preamble
latex_elements['preamble'] += custom_preamble
mathdef_link_only = True
@@ -0,0 +1,21 @@
Index
=====
.. toctree::
:hidden:
:maxdepth: 1
remerciements
getting_started
glossary
all_FAQ
index_et_autre
all_notebooks
blog/blogindex
all_indexes
all_report
blog/index_blog
README
@@ -71,24 +71,10 @@ D'autres informations sont disponibles via le
:ref:`blog <ap-main-0>`.
Annexes
-------
* :ref:`genindex`
* :ref:`l-remerciements`
* :ref:`l-getting_started`
* :ref:`l-glossary`
* :ref:`l-notebooks`
* :ref:`modindex` (voir aussi :ref:`l-modules`, :ref:`l-classes`, :ref:`l-functions`)
* :ref:`l-FAQ`
* :ref:`l-issues-todolist`
.. toctree::
:hidden:
:maxdepth: 1
:maxdepth: 2
remerciements
getting_started
glossary
@@ -143,3 +129,9 @@ Contacts
.. image:: https://codecov.io/github/sdpython/code_beatrix/coverage.svg?branch=master
:target: https://codecov.io/github/sdpython/code_beatrix?branch=master
Annexes
-------
* :ref:`genindex`
* :ref:`modindex` (voir aussi :ref:`l-modules`, :ref:`l-classes`, :ref:`l-functions`)

0 comments on commit 40ad3b6

Please sign in to comment.