Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ RUN echo "sslverify=False" >> /etc/dnf/dnf.conf && \
# Install Python and some requirement dependencies
RUN echo "sslverify=False" >> /etc/dnf/dnf.conf && \
dnf install -y epel-release && \
dnf install -y hdf5 hdf5-devel && \
dnf install -y python3.12 python3.12-devel python3.12-pip && \
dnf -y clean all && \
sed -i '$ d' /etc/dnf/dnf.conf && \
Expand Down
187 changes: 120 additions & 67 deletions README.rst

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions devel/.gitignore

This file was deleted.

176 changes: 0 additions & 176 deletions devel/angles_to_orbits.ipynb

This file was deleted.

75 changes: 0 additions & 75 deletions devel/catalog_to_apparent.c

This file was deleted.

15 changes: 0 additions & 15 deletions devel/export_cache.py

This file was deleted.

13 changes: 0 additions & 13 deletions devel/import_cache.py

This file was deleted.

31 changes: 24 additions & 7 deletions docs/README.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,39 @@
===================
SSAPy Documentation
===================

Building the docs
-----------------

First, build and _install_ `ssapy` following the `Installing SSAPy <https://LLNL.github.io/SSAPy/installation.html>`_ section of the documentation.
First, build and *install* ``ssapy`` by following the
`Installing SSAPy <https://LLNL.github.io/SSAPy/installation.html>`_
section of the documentation.

If needed, install the documentation dependencies:

.. code-block:: bash

pip install -r requirements.txt

Then, to build the HTML documentation locally, from the `docs` directory, run
Then, from the ``docs`` directory, build the HTML documentation locally with:

.. code-block:: bash

make html

(run it twice to generate all files.)
You may need to run this command twice to generate all files correctly.

Then open ``_build/html/index.html`` in a browser to view the documentation locally.

Alternatively, you can run:

.. code-block:: bash

Then open `_build/html/index.html` to browse the docs locally.
sphinx-autobuild source _build/html

Alternatively, you can run `sphinx-autobuild source _build/html` to start a server that watches for changes in `/docs`
and regenerates the HTML docs automatically while serving them at http://127.0.0.1:8000/.
This starts a local server that watches for changes in ``docs/`` and
automatically rebuilds the HTML documentation while serving it at
http://127.0.0.1:8000/.

Note that if you updated docstrings, you'll need to re-build and re-install ssapy before re-building the docs.
Note that if you update docstrings, you may need to rebuild and reinstall
``ssapy`` before rebuilding the documentation.
Loading
Loading