:orphan:

|rss_image| :ref:`<== <ap-cat-documentation-0>`  **documentation - 2/2** :ref:`Blog <ap-main-0>` :ref:`notebook (8) <ap-cat-notebook-0>` :ref:`sphinx (13) <ap-cat-sphinx-0>`

.. |rss_image| image:: feed-icon-16x16.png
    :target: ../_downloads/rss.xml
    :alt: RSS

----


.. _ap-cat-documentation-1:

documentation - 2/2
+++++++++++++++++++

.. blogpostagg::
    :title: Conversion to latex is taking for ever
    :date: 2015-04-16
    :keywords: pdflatex,Jenkins
    :categories: documentation,latex
    :rawfile: 2015/2015-04-16_conversion_latex.rst

    The unit tests are now scheduled using
    `Jenkins <https://jenkins-ci.org/>`_.
    When the documentation is generated for the first
    time after a fresh installation of the machine (latex,
    sphinx...), the compilation can take for ever.
    This is due to extra packages needed by latex.
    When the process is run from a command line, a
    windows shows up asking for approval before
    going on installing the missing latex packages.
    As this command line is showing up in the output,
    it is just needed to executed from a command line window
    to import the missing package.
    After this short break, the latex compilation
    runs fine on Jenkins.




.. blogpostagg::
    :title: Anaconda does not have the latest version of Sphinx
    :date: 2015-04-16
    :keywords: napoleon
    :categories: documentation,anaconda,sphinx
    :rawfile: 2015/2015-04-16_anaconda_sphinx.rst

    As of today, when I type ``conda update sphinx``,
    The Anaconda distribution does not upgrade to 1.3
    and I need it to get the extension
    *sphinx.ext.napoleon*. So I need to type
    ``pip install sphinx --upgrade`` instead.




.. blogpostagg::
    :title: Insert plot from bokeh in the documentation
    :date: 2015-04-12
    :keywords: sphinx,bokeh,bokeh-plot
    :categories: documentation,graph
    :rawfile: 2015/2015-04-12_bokeh_plot.rst

    As graphs from
    `matplotlib <http://matplotlib.org/>`_,
    graphs from
    `bokeh <http://bokeh.pydata.org/>`_
    can be inserted in the documentation with the extension
    `bokeh.sphinxext.bokeh_plot <http://bokeh.pydata.org/en/dev/docs/reference/sphinxext.html#bokeh-sphinxext-bokeh-plot>`_.
    

    ...




.. blogpostagg::
    :title: Sphinx fails because of some weird encoding
    :date: 2015-04-07
    :keywords: sphinx,issue,encoding,BOM,utf-8
    :categories: documentation
    :rawfile: 2015/2015-04-07_issue_with_sphinx.rst

    I have been generating many times the documentation of this module
    and I can tell I went through many errors due to encoding,
    French accents may be sometimes painful to deal with.
    However, I now check every time that every file I produce has
    either no encoding, either is encoded with
    `utf-8 <http://en.wikipedia.org/wiki/UTF-8>`_
    and no `BOM <http://en.wikipedia.org/wiki/Byte_order_mark>`_.
    After I checked that, I'm sure the error come from something else.
    

    ...




.. blogpostagg::
    :title: An example of a blog post included in the documentation
    :date: 2015-04-04
    :keywords: example,blogpost,documentation
    :categories: documentation,example
    :rawfile: 2015/2015-04-04_first_blogpost.rst

    This blog post is an example of a blogpost
    which can be added to the documentation.
    Unfortunately, it does not rely on an existing python blog generator
    as it was difficult to entirely change the existing framework
    and to keep track on references.
    

    ...





----

|rss_image| :ref:`<== <ap-cat-documentation-0>`  **documentation - 2/2** :ref:`2020-08 (2) <ap-month-2020-08-0>` :ref:`2020-09 (1) <ap-month-2020-09-0>` :ref:`2021-01 (1) <ap-month-2021-01-0>` :ref:`2022-03 (1) <ap-month-2022-03-0>` :ref:`2023-05 (1) <ap-month-2023-05-0>`