Skip to content

Commit

Permalink
splitting developer documentation from main doc, adding some links to…
Browse files Browse the repository at this point in the history
… tutorials in case people are coming from here and not the web homepage
  • Loading branch information
scfleming committed Jan 16, 2025
1 parent b4883e2 commit e589c78
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 63 deletions.
65 changes: 65 additions & 0 deletions DEVELOPER_DOC.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
Developer Documentation
-----------------------

This documentation is intended for code maintainers and developers as a guide, especially when preparing to merge and release a new version of the code.

Installation
^^^^^^^^^^^^

.. code-block:: bash
$ git clone https://github.com/spacetelescope/astronify.git
$ cd astronify
$ pip install .
For active development, install in develop mode

.. code-block:: bash
$ pip install -e .
Testing
^^^^^^^
Testing is run with `tox <https://tox.readthedocs.io>`_ (``pip install tox``).
Tests can be found in ``tests/`` sub-directories.

.. code-block:: bash
$ tox -e test
Tests can also be run directly with pytest:

.. code-block:: bash
$ pip install -e .[test]
$ pytest
Documentation
^^^^^^^^^^^^^

Documentation files are found in ``docs/``.

We build the documentation with `tox <https://tox.readthedocs.io>`_ (``pip install tox``):

.. code-block:: bash
$ tox -e build_docs
You can also build the documentation with Sphinx directly using:

.. code-block:: bash
$ pip install -e .[docs]
$ cd docs
$ make html
The built docs will be in ``docs/_build/html/``, to view them go to ``file:///path/to/astronify/repo/docs/_build/html/index.html`` in the browser of your choice.


Release Protocol
^^^^^^^^^^^^^^^^

Coming soon.
71 changes: 8 additions & 63 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,74 +37,19 @@ Project Status
:target: https://codecov.io/gh/spacetelescope/astronify
:alt: Astronify's Codecov coverage status

Developer Documentation
-----------------------

Installation
^^^^^^^^^^^^

.. code-block:: bash
$ git clone https://github.com/spacetelescope/astronify.git
$ cd astronify
$ pip install .
For active development, install in develop mode

.. code-block:: bash
$ pip install -e .
Testing
^^^^^^^
Testing is run with `tox <https://tox.readthedocs.io>`_ (``pip install tox``).
Tests can be found in ``tests/`` sub-directories.

.. code-block:: bash
$ tox -e test
Tests can also be run directly with pytest:

.. code-block:: bash
$ pip install -e .[test]
$ pytest
Documentation
^^^^^^^^^^^^^

Documentation files are found in ``docs/``.

We build the documentation with `tox <https://tox.readthedocs.io>`_ (``pip install tox``):

.. code-block:: bash
$ tox -e build_docs
You can also build the documentation with Sphinx directly using:

.. code-block:: bash
$ pip install -e .[docs]
$ cd docs
$ make html
The built docs will be in ``docs/_build/html/``, to view them go to ``file:///path/to/astronify/repo/docs/_build/html/index.html`` in the browser of your choice.


Release Protocol
^^^^^^^^^^^^^^^^

Follow the `Astropy template release instructions <https://docs.astropy.org/en/stable/development/astropy-package-template.html>`_.
Getting Started
---------------
[Install Instructions](docs/astronify/install.rst)

[Tutorials](docs/notebooks/Intro_Astronify_Series.ipynb)

Contributing
------------

If you are a maintainer of the code, refer to the [developer
documentation](DEVELOPER_DOC.rst) for guidelines on how to release a
new version.

We love contributions! Astronify is open source,
built on open source, and we'd love to have you hang out in our community.

Expand Down

0 comments on commit e589c78

Please sign in to comment.