Skip to content

Commit

Permalink
Update docs to make change of the change to a namespace package.
Browse files Browse the repository at this point in the history
  • Loading branch information
shyuep committed May 13, 2021
1 parent 83cd00e commit 2948799
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 52 deletions.
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Project-style `MongoDB`_ databases for management of materials data. A query
engine is also provided to enable the easy translation of MongoDB docs to
useful pymatgen objects for analysis purposes.

Major change
------------

From v2021.5.13, pymatgen-db is now a proper namespace add-on to pymatgen. In
other words, you no longer import from matgendb but rather pymatgen.db.

Getting pymatgen-db
===================

Expand Down
14 changes: 1 addition & 13 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,7 @@ Other pages
Change Log
==========

v2018.3.28
----------
1. Improved handling of nested db dicts. (Donny Winston)


v2018.2.21
----------
1. Fix --tag option in mgdb to support multiple tags.

v2018.1.4
---------
* Date based versioning in line with pymatgen.
* Fix deprecated code.
:doc:`Change log </change_log>`

Getting pymatgen-db
===================
Expand Down
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
Binary file not shown.
27 changes: 2 additions & 25 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,25 +72,7 @@ <h2>Other pages<a class="headerlink" href="#other-pages" title="Permalink to thi
</div>
<div class="section" id="change-log">
<h1>Change Log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
<div class="section" id="v2018-3-28">
<h2>v2018.3.28<a class="headerlink" href="#v2018-3-28" title="Permalink to this headline"></a></h2>
<ol class="arabic simple">
<li><p>Improved handling of nested db dicts. (Donny Winston)</p></li>
</ol>
</div>
<div class="section" id="v2018-2-21">
<h2>v2018.2.21<a class="headerlink" href="#v2018-2-21" title="Permalink to this headline"></a></h2>
<ol class="arabic simple">
<li><p>Fix –tag option in mgdb to support multiple tags.</p></li>
</ol>
</div>
<div class="section" id="v2018-1-4">
<h2>v2018.1.4<a class="headerlink" href="#v2018-1-4" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Date based versioning in line with pymatgen.</p></li>
<li><p>Fix deprecated code.</p></li>
</ul>
</div>
<p><a class="reference internal" href="change_log.html"><span class="doc">Change log</span></a></p>
</div>
<div class="section" id="getting-pymatgen-db">
<h1>Getting pymatgen-db<a class="headerlink" href="#getting-pymatgen-db" title="Permalink to this headline"></a></h1>
Expand Down Expand Up @@ -312,12 +294,7 @@ <h3><a href="#">Table of Contents</a></h3>
<li><a class="reference internal" href="#other-pages">Other pages</a></li>
</ul>
</li>
<li><a class="reference internal" href="#change-log">Change Log</a><ul>
<li><a class="reference internal" href="#v2018-3-28">v2018.3.28</a></li>
<li><a class="reference internal" href="#v2018-2-21">v2018.2.21</a></li>
<li><a class="reference internal" href="#v2018-1-4">v2018.1.4</a></li>
</ul>
</li>
<li><a class="reference internal" href="#change-log">Change Log</a></li>
<li><a class="reference internal" href="#getting-pymatgen-db">Getting pymatgen-db</a><ul>
<li><a class="reference internal" href="#stable-version">Stable version</a></li>
<li><a class="reference internal" href="#developmental-version">Developmental version</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

14 changes: 1 addition & 13 deletions docs_rst/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,7 @@ Other pages
Change Log
==========

v2018.3.28
----------
1. Improved handling of nested db dicts. (Donny Winston)


v2018.2.21
----------
1. Fix --tag option in mgdb to support multiple tags.

v2018.1.4
---------
* Date based versioning in line with pymatgen.
* Fix deprecated code.
:doc:`Change log </change_log>`

Getting pymatgen-db
===================
Expand Down

0 comments on commit 2948799

Please sign in to comment.