Skip to content

Commit

Permalink
Deploying to gh-pages from @ 174db61 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
tberkel committed Jul 25, 2024
1 parent 02873d1 commit 0e43e39
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,10 @@ This is all controlled by a GitHub Action in `.github/workflows/docs_deploy.yaml
If you forked this repository and you want to view the website on your own GitHub Pages, make sure to enable Actions on your repository,
because they are disabled in forks by default.

## How to Contribute
## How to contribute

1. Add a rst file \"your\_method.rst\" in the [source/user](source/user/) directory in which one describes the basic theory and usage of the method. Reference \"user/your\_method.rst\" in the \"toctree\" section in [source/user.rst](source/user.rst).
2. Add a rst file \"your\_module.rst\" in the [source/modules](source/modules/) directory in which one lists the examples and the member classes and functions of the module (the API doc is then generated by autodoc). (In the \"\_\_init\_\_.py\" file of each module, one should include a simple usage section. See [pyscf.dft.\_\_init\_\_.py](https://github.com/pyscf/pyscf/blob/master/pyscf/dft/__init__.py) as an example.) Reference \"your\_module.rst\" in the \"toctree\" section in [source/modules.rst](source/modules.rst).
3. Optionally, one could also add a rst file \"your\_method\_develop.rst\" in the [source/develop](source/develop/) directory where one provides more detailed descriptions of the implementation and advanced guidelines for using and further development of the module. Reference \"your\_method\_develop.rst\" in [source/develop.rst](source/develop.rst).
Website pages can be written in Markdown `.md` or reStructuredTest `.rst`.

1. Add a rst (or md) file \"your\_method.rst\" in the [source/user](source/user/) directory in which one describes the basic theory and usage of the method. Reference \"user/your\_method.rst\" in the \"toctree\" section in [source/user.rst](source/user.rst).
2. Add a rst (or md) file \"your\_module.rst\" in the [source/modules](source/modules/) directory in which one lists the examples and the member classes and functions of the module (the API doc is then generated by autodoc). (In the \"\_\_init\_\_.py\" file of each module, one should include a simple usage section. See [pyscf.dft.\_\_init\_\_.py](https://github.com/pyscf/pyscf/blob/master/pyscf/dft/__init__.py) as an example.) Reference \"your\_module.rst\" in the \"toctree\" section in [source/modules.rst](source/modules.rst).
3. Optionally, one could also add a rst file \"your\_method\_develop.rst\" in the [source/contributor](source/contributor/) directory where one provides more detailed descriptions of the implementation and advanced guidelines for using and further development of the module.
2 changes: 1 addition & 1 deletion docs/pyscf_api_docs/pyscf.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
<span id="pyscf-md-distributions-module"></span><h2>pyscf.md.distributions module<a class="headerlink" href="#module-pyscf.md.distributions" title="Link to this heading">#</a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="pyscf.md.distributions.MaxwellBoltzmannVelocity">
<span class="sig-prename descclassname"><span class="pre">pyscf.md.distributions.</span></span><span class="sig-name descname"><span class="pre">MaxwellBoltzmannVelocity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">T=298.15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rng=Generator(PCG64)</span> <span class="pre">at</span> <span class="pre">0x7FC38B5A8120</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyscf/md/distributions.html#MaxwellBoltzmannVelocity"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyscf.md.distributions.MaxwellBoltzmannVelocity" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">pyscf.md.distributions.</span></span><span class="sig-name descname"><span class="pre">MaxwellBoltzmannVelocity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">T=298.15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rng=Generator(PCG64)</span> <span class="pre">at</span> <span class="pre">0x7FEA704E0120</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyscf/md/distributions.html#MaxwellBoltzmannVelocity"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyscf.md.distributions.MaxwellBoltzmannVelocity" title="Link to this definition">#</a></dt>
<dd><p>Computes velocities for a molecular structure using
a Maxwell-Boltzmann distribution.
Args:</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 0e43e39

Please sign in to comment.