Skip to content

Commit

Permalink
docs.mpcontribs.org
Browse files Browse the repository at this point in the history
  • Loading branch information
tschaume committed Feb 16, 2021
1 parent 59df520 commit b445a67
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 20 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
![Swagger Validator](https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Fcontribs-api.materialsproject.org%2Fapispec.json&style=flat-square)
![GitHub](https://img.shields.io/github/license/materialsproject/MPContribs?style=flat-square)

| [Documentation](https://mpcontribs.org) | [Portal](https://contribs.materialsproject.org) | [API](https://contribs-api.materialsproject.org) |
| [Documentation](https://docs.mpcontribs.org) | [Portal](https://contribs.materialsproject.org) | [API](https://contribs-api.materialsproject.org) |
|-----------------------------------------|-----------------------------------------|-----------------------------------|

[![social preview](docs/MPContribsGithubSocial.png)](https://contribs.materialsproject.org)
2 changes: 1 addition & 1 deletion docs/CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
mpcontribs.org
docs.mpcontribs.org
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
site_name: 'MPContribs'
site_description: 'Contributed MP Materials Data'
site_author: 'Patrick Huck'
site_url: 'https://mpcontribs.org'
site_url: 'https://docs.mpcontribs.org'

repo_name: 'materialsproject/MPContribs'
repo_url: 'https://github.com/materialsproject/MPContribs'
Expand Down
2 changes: 1 addition & 1 deletion mpcontribs-api/mpcontribs/api/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"contact": {
"name": "MPContribs",
"email": "[email protected]",
"url": "https://mpcontribs.org",
"url": "https://docs.mpcontribs.org",
},
"license": {
"name": "Creative Commons Attribution 4.0 International License",
Expand Down
2 changes: 1 addition & 1 deletion mpcontribs-api/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
description="API for community-contributed Materials Project data",
author="Patrick Huck",
author_email="[email protected]",
url="https://mpcontribs.org",
url="https://docs.mpcontribs.org",
packages=["mpcontribs.api"],
install_requires=required,
license="MIT",
Expand Down
2 changes: 1 addition & 1 deletion mpcontribs-client/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![PyPI](https://img.shields.io/pypi/v/mpcontribs-client?style=flat-square)
![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/pypi/mpcontribs-client?style=flat-square)

Small, dynamic python client library to connect to [MPContribs](https://mpcontribs.org)
Small, dynamic python client library to connect to [MPContribs](https://docs.mpcontribs.org)
APIs based on Yelp's [bravado](https://bravado.readthedocs.io).

```python
Expand Down
2 changes: 1 addition & 1 deletion mpcontribs-io/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
MPContribs I/O Library. See the [MPContribs Docs](https://mpcontribs.org) for specific usage and examples.
MPContribs I/O Library. See the [MPContribs Docs](https://docs.mpcontribs.org) for specific usage and examples.
17 changes: 10 additions & 7 deletions mpcontribs-portal/mpcontribs/portal/templates/header_footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,18 @@
</li>
<li data-intro="Apply for your own project."
data-step="4">
<a id="apply-toggle" href="/apply">Apply</a></li>
<a id="apply-toggle" href="/apply">Apply</a>
</li>
<li data-intro="Explore code examples from other projects."
data-step="5">
<a id="work-toggle" href="/work">Work</a></li>
<a id="work-toggle" href="/work">Work</a>
</li>
<li>
<!-- TODO link to local docs in dev -->
<a id=docs_url target="_blank" href="https://docs.mpcontribs.org">
Docs
</a>
</li>
</ul>
</div>
</div>
Expand All @@ -72,11 +80,6 @@
<span class="icon"><i class="fas fa-question"></i></span>
<span>Tour this page</span>
</a>
<!-- TODO link to local docs in dev -->
<a class="navbar-item" id=docs_url target="_blank" href="https://mpcontribs.org">
<span class="icon"><i class="fab fa-readme"></i></span>
<span>Documentation</span>
</a>
<a class="navbar-item" name=api_url target="_blank">
<span class="icon"><i class="fas fa-laptop-code"></i></span>
<span>RESTful API</span>
Expand Down
2 changes: 1 addition & 1 deletion mpcontribs-portal/mpcontribs/portal/templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
href=https://materialsproject.org/materials/mp-22987/#user-contribs>materials
details pages</a>, in form of domain-specific interactive landing pages on this
portal, and programmatically through its RESTful API. See the
<a href=https://mpcontribs.org>documentation</a> for more info.
<a href=https://docs.mpcontribs.org>documentation</a> for more info.
</div>
</article>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h5>Theoretical data updated: </h4>
isobar, and isoredox functions, use the dropdown menu. Variables
and plot ranges can be adjusted with the sliders. All thermodynamic
quantities are given as per mol of O (monatomic oxygen). Please refer
to the <a href="https://mpcontribs.org/redox_thermo_csp/">documentation</a>
to the <a href="https://docs.mpcontribs.org/redox_thermo_csp/">documentation</a>
for more detailed information.</small>
</div>
</div>
Expand Down Expand Up @@ -231,7 +231,7 @@ <h3>Energy Analysis</h3>
of redox reactions. Not all materials shown here are necessarily
stable or can be synthesized. This tool allows a pre-selection
of materials. Please refer to the
<a href="https://mpcontribs.org/redox_thermo_csp/">documentation</a>
<a href="https://docs.mpcontribs.org/redox_thermo_csp/">documentation</a>
for more detailed information.
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"client.projects.update_entry(pk=name, project={\n",
" 'unique_identifiers': False,\n",
" 'references': [\n",
" {'label': 'Docs', 'url': 'https://mpcontribs.org'},\n",
" {'label': 'Docs', 'url': 'https://docs.mpcontribs.org'},\n",
" {'label': 'Source', 'url': 'https://refractiveindex.info'}\n",
" ]\n",
"}).result()"
Expand Down
2 changes: 1 addition & 1 deletion mpcontribs-portal/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "1.0.0",
"private": true,
"description": "",
"homepage": "https://mpcontribs.org",
"homepage": "https://docs.mpcontribs.org",
"bugs": {
"url": "https://github.com/materialsproject/MPContribs/issues"
},
Expand Down
2 changes: 1 addition & 1 deletion mpcontribs-portal/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
description="MPContribs Portal",
author="Patrick Huck",
author_email="[email protected]",
url="https://mpcontribs.org",
url="https://docs.mpcontribs.org",
packages=["mpcontribs.portal", "mpcontribs.users"],
install_requires=required,
license="MIT",
Expand Down

0 comments on commit b445a67

Please sign in to comment.