-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a README file for the documentation. And fix the language paramet…
…er in the conf.py file for the english version.
- Loading branch information
Showing
2 changed files
with
35 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters