Skip to content

Documentation dev workflow

raphael dussin edited this page Aug 2, 2019 · 1 revision
  • Setting up your conda environment:
conda create -n mom6docs
source activate mom6docs
conda install doxygen
git clone https://github.com/angus-g/sphinx-fortran.git
( cd sphinx-fortran ; pip install -e . )
git clone https://github.com/angus-g/sphinxcontrib-autodoc_doxygen.git
( cd sphinxcontrib-autodoc_doxygen ; pip install -e . )
  • Download MOM6 code and build documentation:
git clone git@github.com:<YOUR_FORK_HERE>/MOM6.git
cd MOM6/docs
make Clean; make html
  • link to readthedocs:

Create a rtd account (if not already have one), login -> import a project, choose your forked MOM6 github repo. Then go to Versions, click edit on the branch your want to use, check active box. Go to builds and it should be added to the list of builds.

Clone this wiki locally