...
Installing a python package in a virtual environment keeps it from being installed system wide which is good practice and also useful if you don’t have permissions to install system-level packages.
Expand | ||
---|---|---|
| ||
The same python environment above can be achieve with conda. To do so, create a conda environment with a |
Use local environment to build/test documentation changes
...
cd top the top level E3SM directory and see if you can build the current docs by typing
mkdocs build
View the docs locally in your browser with the built-in server
mkdocs serve
(Follow the instructions output by the above command to display in your browser. control-C to end server)
As you edit the documentation, rerun the “mkdocs build” command and refresh the website in your browser. The output of “mkdocs build” will tell you if you have a syntax error in your markdown files. The website in your browser will let you know if it looks as you intended
Expand | ||
---|---|---|
| ||
EAMxx docs use an automated routine to populate the namelist parameters. In order to avoid warnings on this step, please ensure you have a copy of the CIME submodule inside your main repo. Then, you will be able to build with |
View the docs locally in your browser with the built-in server
mkdocs serve
(Follow the instructions output by the above command to display in your browser. control-C to end server)
Expand | ||
---|---|---|
| ||
An alternative to |
As you edit the documentation, rerun the “mkdocs build” command and refresh the website in your browser. The output of “mkdocs build” will tell you if you have a syntax error in your markdown files. The website in your browser will let you know if it looks as you intended
Documentation organization
...