https://github.com/e3sm-project/e3sm_data_docs
Documentation on E3SM simulations
https://github.com/e3sm-project/e3sm_data_docs
Last synced: 8 months ago
JSON representation
Documentation on E3SM simulations
- Host: GitHub
- URL: https://github.com/e3sm-project/e3sm_data_docs
- Owner: E3SM-Project
- Created: 2022-06-20T18:12:38.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T22:39:36.000Z (over 1 year ago)
- Last Synced: 2024-11-21T23:22:38.852Z (over 1 year ago)
- Language: Shell
- Homepage: https://e3sm-project.github.io/e3sm_data_docs/
- Size: 3.01 MB
- Stars: 0
- Watchers: 119
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
E3SM Data Documentation
=======================
`Documentation page `_.
If you'd like to contribute to this documentation, please follow the steps below.
Getting Started
--------------------------
This documentation is created using
`Sphinx `_. Sphinx is an open-source tool
that makes it easy to create intelligent and beautiful documentation, written
by Georg Brandl and licensed under the BSD license.
The documentation is maintained in the ``main`` branch of the GitHub repository.
You can include code and its corresponding documentation updates in a single pull request (PR).
After merging a PR, GitHub Actions automates the documentation building process.
It pushes the HTML build to the ``gh-pages`` branch, which is hosted on GitHub Pages.
.. _conda-env:
Setup the Conda Environment
-------------------------------
1. Install Miniconda/Anaconda
2. Clone the repository ::
git clone git@github.com:E3SM-Project/e3sm_data_docs.git
3. Enter the repo directory ::
cd e3sm_data_docs
4. Create the ``e3sm_data_docs`` conda environment ::
conda env create -f conda-env/docs.yml
conda activate e3sm_data_docs
Edit Documentation
-------------------------------
Sphinx uses `reStructuredText `_ as its markup language. For more information on how to write documentation using Sphinx, you can refer to:
* `First Steps with Sphinx `_
* `reStructuredText Primer `_
1. Create a branch from ``main`` ::
git checkout main
git checkout -b
2. Edit the ``rst`` files under ``/docs/source``.
3. Build the HTML pages : ::
cd docs
make html
4. View them locally in a web browser at ``file:////e3sm_data_docs/docs/_build/html/index.html``
5. Commit and push changes ::
cd /e3sm_data_docs
# `docs/_build` is ignored by git since it does not need to be pushed.
git add .
git commit "..."
git push
6. Create a pull request
Once this pull request is merged and GitHub Actions finishes building the docs, changes will be available on the
`e3sm_data_docs documentation page `_.