diff --git a/docs/guides/releases.md b/docs/guides/releases.md deleted file mode 100644 index ac239ca..0000000 --- a/docs/guides/releases.md +++ /dev/null @@ -1 +0,0 @@ -# Releases diff --git a/docs/index.md b/docs/index.md index 125ccfd..d2e3dab 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,20 +8,24 @@ The goal of this project is to provide a Python library with minimal dependencie Pretty print the available surveys and associated filters in the terminal -``` +```bash galcheat ``` + ### Options + - **`-s `**: print information for a given survey - **`--refs`**: print the source for each parameter - **`-h, --help`**: get help -### Exemples +### Examples + ```sh galcheat -s LSST # LSST info galcheat --refs # all surveys info with refs galcheat --refs -s HSC # HSC info with refs ``` + ## Installation ```sh diff --git a/docs/parameters.md b/docs/parameters.md index 06f3420..78b4f23 100644 --- a/docs/parameters.md +++ b/docs/parameters.md @@ -5,6 +5,7 @@ The following page describes the parameters of the photometric surveys and their Survey parameters ----------------- + ### Input parameters The following parameters are required in the YAML file describing any survey to build the `Survey` class in `galcheat`. diff --git a/mkdocs.yml b/mkdocs.yml index 0d01cb5..988e6bd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,9 +36,8 @@ nav: - Parameters: parameters.md - Guides: - Getting Started: guides/getting-started.md + - Simulate Galaxy with Galsim: guides/create-galaxy.md - Extend galcheat objects: guides/heritage.md - - Releases: guides/releases.md - - Create Galaxy: guides/create-galaxy.md - API: - galcheat.survey: api/survey.md - galcheat.filter: api/filter.md