Skip to content

Commit

Permalink
Add a README file for the documentation. And fix the language paramet…
Browse files Browse the repository at this point in the history
…er in the conf.py file for the english version.
  • Loading branch information
beaud76 committed Feb 18, 2017
1 parent 094d26e commit 8f40cc0
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
34 changes: 34 additions & 0 deletions docs/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
E-Maj Documentation
===================

The documentation can be reached at http://emaj.readthedocs.io/


Compile the doc
---------------

* Install Sphinx (here in debian style) ::

apt-get install python-sphinx


* Get the Sphinx Theme

Install the [Read The Doc theme](https://github.com/snide/sphinx_rtd_theme)::

pip install sphinx_rtd_theme

And then add the following lines to the ``conf.py`` file::

import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]


* Build::

cd docs/<selected_language>
make html

The resulting files are then located under docs/<language>/_build/html.

2 changes: 1 addition & 1 deletion docs/en/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'English'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down

0 comments on commit 8f40cc0

Please sign in to comment.