source: trunk/docs/manual/source/developers/guides/requirements.rst @ 10

Last change on this file since 10 was 10, checked in by pinsard, 9 years ago

add build doc procedure
File size: 2.3 KB

Requirements

Access to forge

Developer must be a member of the project |igcmg_doc| on the IPSL forge.
http://forge.ipsl.jussieu.fr/igcmg_doc/.

Administrators are :

  • Anne Cozic
  • Josefine Ghattas
  • Sonia Labetoulle

Working space

Note

ciclad-ng only

All procedures described here are tested on ciclad-ng.private.ipsl.fr.

?
.. todo::
   warn on some variations on other platforms
   - :command:`sed` vs  :command:`gsed`
   - :command:`xdg-open` vs  :command:`open`
   - python distribution
   - locale setup (ie values of :envvar:`LC` and associates)

Define :envvar:`PROJECT` as base directory and download the repository :

?
PROJECT=${HOME}/igcmg_doc_ws  # ${HOME}/igcmg_doc_ws is an example
export PROJECT
loginforge=yourlogin  # login on forge.ipsl.jussieu.fr
svn checkout svn+ssh://${loginforge}@forge.ipsl.jussieu.fr/ipsl/forge/projets/igcmg_doc/svn/trunk ${PROJECT}

Environment

Python environment

anaconda environment creation

Here you will create a Python environement based on ananconda distribution. This has to be done only once.

module load python/2.7-anaconda
conda create --name conda-igcmg_doc-dev sphinx pep8 pyflakes pylint
source activate conda-igcmg_doc-dev
pip install --upgrade pyenchant
pip install --upgrade doc8
pip install --upgrade sphinxcontrib-blockdiag
source deactivate
?
.. todo:: explain why
?
.. todo:: explain how to update

anaconda environment activation

To activate this environment once created

source activate conda-igcmg_doc-dev

anaconda environment deactivation

To deactivate it:

source deactivate

Shell environment

?
.. todo:: mentionned atlas bash
?
.. todo:: put this in a login file

:envvar:`PYTHONPATH` and :envvar:`PATH` setup:

??
PYTHONPATH=${PROJECT}/docs/manual/:${PYTHONPATH}
export PYTHONPATH
PATH=${PROJECT}/docs/manual/:${PATH}
export PATH

:envvar:`PROJECT_LOG` is the base directory of temporary files build for example during the :ref:`typo` procedure.

??
PROJECT_LOG=${HOME}/log/
export PROJECT_LOG
mkdir ${PROJECT_LOG} # only once

Docutils System Messages

?
Note: See TracBrowser for help on using the repository browser.