Skip to content

Commit

Permalink
Update references to docs URL now that NREL#26 is merged
Browse files Browse the repository at this point in the history
  • Loading branch information
softwareengineerprogrammer committed Nov 2, 2023
1 parent 6558d9d commit 93e675c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Free software: `MIT license <LICENSE>`_
:target: https://github.com/NREL/python-geophires-x/compare/v3.2.0...main

.. |docs| image:: https://readthedocs.org/projects/python-geophires-x/badge/?style=flat
:target: https://softwareengineerprogrammer.github.io/python-geophires-x-nrel
:target: https://nrel.github.io/python-geophires-x
:alt: Documentation Status

.. TODO coverage badge https://github.com/NREL/python-geophires-x/issues/22
Expand Down Expand Up @@ -111,7 +111,7 @@ Example usage:
with open(result.output_file_path,'r') as f:
print(f.read())
Available parameters are documented in the `Parameters Reference <https://softwareengineerprogrammer.github.io/python-geophires-x-nrel/parameters.html>`__.
Available parameters are documented in the `Parameters Reference <https://nrel.github.io/python-geophires-x/parameters.html>`__.

You may also pass parameters as a text file:

Expand Down Expand Up @@ -140,7 +140,7 @@ A variety of examples input ``.txt`` files are available in the `tests/examples
Documentation
=============

* `Parameters Reference <https://softwareengineerprogrammer.github.io/python-geophires-x-nrel/parameters.html>`__
* `Parameters Reference <https://nrel.github.io/python-geophires-x/parameters.html>`__
* `How to extend GEOPHIRES-X <docs/How-to-extend-GEOPHIRES-X.md>`__ user guide

The `GEOPHIRES v2.0 (previous version's) user manual <References/GEOPHIRES%20v2.0%20User%20Manual.pdf>`__ describes GEOPHIRES's high-level software architecture.
Expand Down
10 changes: 7 additions & 3 deletions docs/templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@
<script type="text/javascript">
console.debug('Referrer:', document.referrer)

/* Redirect links from forks' docs to NREL's */
if(document.referrer === "https://github.com/NREL/python-geophires-x"){
location.href = "https://NREL.github.io/python-geophires-x/"
if (location.href.indexOf("nrel.github.io/python-geophires-x") !== -1
&& document.referrer.indexOf("https://github.com/softwareengineerprogrammer/python-geophires-x") !== -1) {
/* Redirect links from fork's GitHub docs to fork's docs deployment */
location.href = location.href.replace(
"nrel.github.io/python-geophires-x",
"softwareengineerprogrammer.github.io/python-geophires-x-nrel"
)
}
</script>
{% endblock %}

0 comments on commit 93e675c

Please sign in to comment.