Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 21, 2025
1 parent 680b795 commit cefb4db
Show file tree
Hide file tree
Showing 44 changed files with 12 additions and 14 deletions.
2 changes: 1 addition & 1 deletion _build/html/main/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 495eb6909d974efa240667839dcaf8ce
config: d32594b05212b36d07e388943bc79d25
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified _build/html/main/.doctrees/add-new-diagnostics.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/available-parameters.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/colormaps.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/config-run.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/contributing.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/defining-parameters.doctree
Binary file not shown.
Binary file not shown.
Binary file modified _build/html/main/.doctrees/dev_guide/index.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/dev_guide/project-standards.doctree
Binary file not shown.
Binary file not shown.
Binary file modified _build/html/main/.doctrees/dev_guide/testing.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/dev_guide/using-output-viewer.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/environment.pickle
Binary file not shown.
Binary file modified _build/html/main/.doctrees/examples.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/index.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/input-data-requirement.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/install.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/index.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/old/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/quick-guide-acme1.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/quick-guide-anvil.doctree
Binary file not shown.
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/quick-guide-compy.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
11 changes: 5 additions & 6 deletions _build/html/main/_sources/dev_guide/project-standards.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Manually run all pre-commit hooks ::

Run individual hook ::

# Available hook ids: trailing-whitespace, end-of-file-fixer, check-yaml, black, isort, flake8, mypy
# Available hook ids: trailing-whitespace, end-of-file-fixer, check-yaml, ruff, and mypy
pre-commit run <hook_id>

Squash and Rebase Commits
Expand Down Expand Up @@ -131,9 +131,8 @@ Code Quality Assurance

This project uses several tools for code formatting, linting, and type checking listed below.

- Code Formatting: `black <https://black.readthedocs.io/en/stable/>`__
- Linting: `flake8 <https://github.com/PyCQA/flake8#flake8>`__, `isort <https://pycqa.github.io/isort/>`__
- Optional Type Checking: `mypy <http://mypy-lang.org/>`__
- `Ruff <https://docs.astral.sh/ruff/>`__ for code formatting and linting.
- `mypy <http://mypy-lang.org/>`_` for type checking.`

You can run them as hooks manually/automatically when committing using ``pre-commit``, or manually through the terminal or IDE/text editor.

Expand All @@ -143,7 +142,7 @@ Helpful Commands
Run a tool
::

# Available tool names: black, flake8, isort, mypy
# Available tool names: ruff format, ruff check, mypy
<tool_name> .

.. _ci-cd:
Expand Down Expand Up @@ -174,7 +173,7 @@ This project uses `GitHub Actions <https://github.com/E3SM-Project/e3sm_diags/ac
Style Guide
-----------

This project follows the Black code style. Please read about it more `here <https://black.readthedocs.io/en/stable/the_black_code_style.html>`__.
This project follows the Ruff code style. Please read about it more `here <https://docs.astral.sh/ruff/formatter/>`__.

API Documentation
-----------------
Expand Down
11 changes: 5 additions & 6 deletions _build/html/main/dev_guide/project-standards.html
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ <h4>Helpful Commands<a class="headerlink" href="#helpful-commands" title="Link t
</pre></div>
</div>
<p>Run individual hook</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Available hook ids: trailing-whitespace, end-of-file-fixer, check-yaml, black, isort, flake8, mypy</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Available hook ids: trailing-whitespace, end-of-file-fixer, check-yaml, ruff, and mypy</span>
<span class="n">pre</span><span class="o">-</span><span class="n">commit</span> <span class="n">run</span> <span class="o">&lt;</span><span class="n">hook_id</span><span class="o">&gt;</span>
</pre></div>
</div>
Expand Down Expand Up @@ -249,15 +249,14 @@ <h4>How to squash and rebase commits<a class="headerlink" href="#how-to-squash-a
<h2>Code Quality Assurance<a class="headerlink" href="#code-quality-assurance" title="Link to this heading"></a></h2>
<p>This project uses several tools for code formatting, linting, and type checking listed below.</p>
<ul class="simple">
<li><p>Code Formatting: <a class="reference external" href="https://black.readthedocs.io/en/stable/">black</a></p></li>
<li><p>Linting: <a class="reference external" href="https://github.com/PyCQA/flake8#flake8">flake8</a>, <a class="reference external" href="https://pycqa.github.io/isort/">isort</a></p></li>
<li><p>Optional Type Checking: <a class="reference external" href="http://mypy-lang.org/">mypy</a></p></li>
<li><p><a class="reference external" href="https://docs.astral.sh/ruff/">Ruff</a> for code formatting and linting.</p></li>
<li><p><cite>mypy &lt;http://mypy-lang.org/&gt;`_</cite> for type checking.`</p></li>
</ul>
<p>You can run them as hooks manually/automatically when committing using <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code>, or manually through the terminal or IDE/text editor.</p>
<section id="id1">
<h3>Helpful Commands<a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
<dl>
<dt>Run a tool</dt><dd><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Available tool names: black, flake8, isort, mypy</span>
<dt>Run a tool</dt><dd><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Available tool names: ruff format, ruff check, mypy</span>
<span class="o">&lt;</span><span class="n">tool_name</span><span class="o">&gt;</span> <span class="o">.</span>
</pre></div>
</div>
Expand Down Expand Up @@ -297,7 +296,7 @@ <h3>Helpful Commands<a class="headerlink" href="#id1" title="Link to this headin
</section>
<section id="style-guide">
<h2>Style Guide<a class="headerlink" href="#style-guide" title="Link to this heading"></a></h2>
<p>This project follows the Black code style. Please read about it more <a class="reference external" href="https://black.readthedocs.io/en/stable/the_black_code_style.html">here</a>.</p>
<p>This project follows the Ruff code style. Please read about it more <a class="reference external" href="https://docs.astral.sh/ruff/formatter/">here</a>.</p>
</section>
<section id="api-documentation">
<h2>API Documentation<a class="headerlink" href="#api-documentation" title="Link to this heading"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion _build/html/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit cefb4db

Please sign in to comment.