-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
splitting developer documentation from main doc, adding some links to…
… tutorials in case people are coming from here and not the web homepage
- Loading branch information
Showing
2 changed files
with
73 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters