Skip to content

Commit

Permalink
update doc configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
weaverba137 committed Aug 7, 2023
1 parent d41b80b commit b55a3ea
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 15 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci_cron_weekly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ jobs:
doc_test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
- name: Set up Python to build docs with sphinx
uses: actions/setup-python@v2
uses: actions/setup-python@v4
with:
python-version: 3.8
- name: Install base dependencies
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,19 +64,19 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up python ${{ matrix.python }} on ${{ matrix.os }}
uses: actions/setup-python@v2
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python }}
- name: Install base dependencies
run: |
python -m pip install --upgrade pip
python -m pip install tox coveralls
- name: Install graphviz dependency
if: "endsWith(matrix.toxenv, 'build_docs')"
if: ${{ endsWith(matrix.toxenv, 'build_docs') }}
run: sudo apt-get -y install graphviz
- name: Test with tox
env:
Expand Down
1 change: 0 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ sphinx:

# Optionally declare the Python requirements required to build your docs
python:
system_packages: false
install:
- method: pip
path: .
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ Legal
.. _SDSS: https://www.sdss.org
.. _`Goddard utilities`: https://idlastro.gsfc.nasa.gov/
.. _idlspec2d: https://svn.sdss.org/public/repo/eboss/idlspec2d/trunk/
.. _BOSS: https://www.sdss.org/surveys/boss/
.. _eBOSS: https://www.sdss.org/surveys/eboss/
.. _BOSS: https://www.sdss4.org/surveys/boss/
.. _eBOSS: https://www.sdss4.org/surveys/eboss/
.. _photoop: https://svn.sdss.org/public/repo/sdss/photoop/trunk/
.. _astropy: http://www.astropy.org
.. _PyPI: https://pypi.python.org/pypi/pydl/
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ Base API
.. _SDSS: https://www.sdss.org
.. _`Goddard utilities`: https://idlastro.gsfc.nasa.gov/
.. _idlspec2d: https://svn.sdss.org/public/repo/eboss/idlspec2d/trunk/
.. _BOSS: https://www.sdss.org/surveys/boss/
.. _eBOSS: https://www.sdss.org/surveys/eboss/
.. _BOSS: https://www.sdss4.org/surveys/boss/
.. _eBOSS: https://www.sdss4.org/surveys/eboss/
.. _photoop: https://svn.sdss.org/public/repo/sdss/photoop/trunk/
.. .. _astropy: http://www.astropy.org
.. _PyPI: https://pypi.org/project/pydl/
Expand Down
8 changes: 4 additions & 4 deletions docs/pydlspec2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ testsuite None Tools for high-level quality assurance, *e.g.* compar
========== =============== ===================================================

.. _idlspec2d: https://svn.sdss.org/public/repo/eboss/idlspec2d/trunk/
.. _`SDSS Legacy`: https://classic.sdss.org/legacy/index.html
.. _BOSS: https://www.sdss.org/surveys/boss/
.. _eBOSS: https://www.sdss.org/surveys/eboss/
.. _APOGEE-2: https://www.sdss.org/surveys/apogee-2/
.. _`SDSS Legacy`: https://classic.sdss.org/legacy/index.php
.. _BOSS: https://www.sdss4.org/surveys/boss/
.. _eBOSS: https://www.sdss4.org/surveys/eboss/
.. _APOGEE-2: https://www.sdss4.org/surveys/apogee-2/

API
+++
Expand Down
2 changes: 1 addition & 1 deletion docs/templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ function-by-function, to the equivalent `IDL®`_ code, ensuring that the
results were the same, to some numerical precision.

.. _SDSS: https://www.sdss.org
.. _BOSS: https://www.sdss.org/surveys/boss/
.. _BOSS: https://www.sdss4.org/surveys/boss/
.. _`IDL®`: https://www.l3harrisgeospatial.com/Software-Technology/IDL
.. [1] `Bolton, Adam, et al. 2012 AJ 144, 144 <https://ui.adsabs.harvard.edu/abs/2011ApJ...738...20T/abstract>`_.
.. [2] `Tsalmantza, P., Decarli, R., Dotti, M., Hogg, D. W., 2011 ApJ 738, 20
Expand Down

0 comments on commit b55a3ea

Please sign in to comment.