{"id":22410968,"url":"https://github.com/e3sm-project/e3sm_data_docs","last_synced_at":"2025-10-14T03:58:19.976Z","repository":{"id":39715810,"uuid":"505550006","full_name":"E3SM-Project/e3sm_data_docs","owner":"E3SM-Project","description":"Documentation on E3SM simulations","archived":false,"fork":false,"pushed_at":"2024-11-21T22:39:36.000Z","size":3159,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":119,"default_branch":"main","last_synced_at":"2024-11-21T23:22:38.852Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://e3sm-project.github.io/e3sm_data_docs/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/E3SM-Project.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-20T18:12:38.000Z","updated_at":"2024-11-20T00:20:23.000Z","dependencies_parsed_at":"2024-11-21T23:30:57.295Z","dependency_job_id":null,"html_url":"https://github.com/E3SM-Project/e3sm_data_docs","commit_stats":{"total_commits":33,"total_committers":4,"mean_commits":8.25,"dds":0.5151515151515151,"last_synced_commit":"ce4edefcc859c4d7cb05fe682977f8e7e8c61146"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/E3SM-Project%2Fe3sm_data_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/E3SM-Project%2Fe3sm_data_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/E3SM-Project%2Fe3sm_data_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/E3SM-Project%2Fe3sm_data_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/E3SM-Project","download_url":"https://codeload.github.com/E3SM-Project/e3sm_data_docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228304099,"owners_count":17898920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-05T13:12:32.293Z","updated_at":"2025-10-14T03:58:19.894Z","avatar_url":"https://github.com/E3SM-Project.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"E3SM Data Documentation\n=======================\n\n`Documentation page \u003chttps://e3sm-project.github.io/e3sm_data_docs/\u003e`_.\n\nIf you'd like to contribute to this documentation, please follow the steps below.\n\nGetting Started\n--------------------------\n\nThis documentation is created using\n`Sphinx \u003chttp://www.sphinx-doc.org/en/stable\u003e`_. Sphinx is an open-source tool\nthat makes it easy to create intelligent and beautiful documentation, written\nby Georg Brandl and licensed under the BSD license.\n\nThe documentation is maintained in the ``main`` branch of the GitHub repository.\nYou can include code and its corresponding documentation updates in a single pull request (PR).\n\nAfter merging a PR, GitHub Actions automates the documentation building process.\nIt pushes the HTML build to the ``gh-pages`` branch, which is hosted on GitHub Pages.\n\n.. _conda-env:\n\nSetup the Conda Environment\n-------------------------------\n\n1. Install Miniconda/Anaconda\n\n2. Clone the repository ::\n\n        git clone git@github.com:E3SM-Project/e3sm_data_docs.git\n\n3. Enter the repo directory ::\n\n        cd e3sm_data_docs\n\n4. Create the ``e3sm_data_docs`` conda environment ::\n\n        conda env create -f conda-env/docs.yml\n        conda activate e3sm_data_docs\n\nEdit Documentation\n-------------------------------\n\nSphinx uses `reStructuredText \u003chttp://docutils.sourceforge.net/rst.html\u003e`_ as its markup language. For more information on how to write documentation using Sphinx, you can refer to:\n\n* `First Steps with Sphinx \u003chttp://www.sphinx-doc.org/en/stable/tutorial.html\u003e`_\n* `reStructuredText Primer \u003chttp://www.sphinx-doc.org/en/stable/rest.html#external-links\u003e`_\n\n1. Create a branch from ``main``  ::\n\n    git checkout main\n    git checkout -b \u003cBRANCH_NAME\u003e\n\n2. Edit the ``rst`` files under ``/docs/source``.\n\n3. Build the HTML pages : ::\n\n    cd docs\n    make html\n\n4. View them locally in a web browser at ``file:///\u003cmyDir\u003e/e3sm_data_docs/docs/_build/html/index.html``\n\n5. Commit and push changes ::\n\n    cd \u003cmyDir\u003e/e3sm_data_docs\n    # `docs/_build` is ignored by git since it does not need to be pushed.\n    git add .\n    git commit \"...\"\n    git push \u003cfork-origin\u003e \u003cbranch-name\u003e\n\n6. Create a pull request\n\nOnce this pull request is merged and GitHub Actions finishes building the docs, changes will be available on the\n`e3sm_data_docs documentation page \u003chttps://e3sm-project.github.io/e3sm_data_docs/\u003e`_.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fe3sm-project%2Fe3sm_data_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fe3sm-project%2Fe3sm_data_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fe3sm-project%2Fe3sm_data_docs/lists"}