Skip to content

DOC: Expanded landing page documentation #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rrjbca merged 18 commits into from
Jun 22, 2021
Merged

DOC: Expanded landing page documentation #228

Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
6238ac1
initial commit, using astropy as an example
itrharrison Jul 15, 2020
afc08a6
added more documentation
itrharrison Jul 17, 2020
4933fb9
moved to correct dir
itrharrison Jul 17, 2020
d58a871
commented out nonexisting docs
itrharrison Jul 17, 2020
8937738
commented out nonexisting docs
itrharrison Jul 17, 2020
4817c30
commenting doesnt seem to work. deleted
itrharrison Jul 17, 2020
042d204
added minimum versions to config
itrharrison Jul 17, 2020
5efcb0e
fixed style issues
itrharrison Jul 17, 2020
bd71e14
added import
itrharrison Jul 20, 2020
51be3ef
Merge branch 'master' into docs-expanded-landing
itrharrison Jul 20, 2020
8225b7b
blank lines
itrharrison Jul 20, 2020
376faaa
removed bad line from doctest
itrharrison Aug 19, 2020
83f62f6
remove changes implemented in the meantime
ntessore Jun 22, 2021
1ae8c99
Delete importing_skypy.rst
ntessore Jun 22, 2021
1d69222
Delete install.rst
ntessore Jun 22, 2021
74551af
Delete running_skypy.rst
ntessore Jun 22, 2021
f5c20a5
Merge branch 'main' into docs-expanded-landing
rrjbca Jun 22, 2021
c34f884
Apply suggestions from code review
rrjbca Jun 22, 2021
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
11 changes: 9 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@
SkyPy Documentation
###################

This package contains methods for modelling the Universe, galaxies and the Milky Way. Also included are methods for generating observed data.

This package contains methods for modelling the Universe, galaxies and the
Milky Way. SkyPy simulates populations of astronomical objects, generating
random realisations of intrinsic and observed properties, with the
intention the simulations can then be compared to data as part of an inference
pipeline.

.. Important:: If you use SkyPy for work presented in a publication or talk
please help the project via proper `citation or acknowledgement
<https://github.com/skypyproject/skypy/blob/main/CITATION.rst>`_.

.. _getting-started:

Expand Down