* Adding readthedocs configs

* Theme change to pydata
* Index page change.

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

README.md

@@ -1,6 +1,6 @@
 # PANOPTES Data tools
 
-Tools for working with PANOPTES data.
+Tools for searching and downloading PANOPTES data.
 
 ## Install
 

docs/conf.py

@@ -171,7 +171,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "alabaster"
+html_theme = "pydata_sphinx_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -301,4 +301,4 @@
     "pyscaffold": ("https://pyscaffold.org/en/stable", None),
 }
 
-print(f"loading configurations for {project} {version} ...", file=sys.stderr)
+print(f"loading configurations for {project} {version} ...", file=sys.stderr)

docs/index.md

@@ -1,29 +1,13 @@
-# panoptes-data
-
-Tools for working with PANOPTES data.
-
-
-## Note
-
-> This is the main page of your project's [Sphinx] documentation. It is
-> formatted in [Markdown]. Add additional pages by creating md-files in
-> `docs` or rst-files (formatted in [reStructuredText]) and adding links to
-> them in the `Contents` section below.
->
-> Please check [Sphinx] and [MyST] for more information
-> about how to document your project and how to configure your preferences.
-
+```{include} ../README.md
+:relative-docs: docs/
+:relative-images:
+```
 
-## Contents
+## API reference
 
 ```{toctree}
 :maxdepth: 2
 
-Overview <readme>
-Contributions & Help <contributing>
-License <license>
-Authors <authors>
-Changelog <changelog>
 Module Reference <api/modules>
 ```
 
@@ -34,6 +18,9 @@ Module Reference <api/modules>
 * {ref}`search`
 
 [Sphinx]: http://www.sphinx-doc.org/
+
 [Markdown]: https://daringfireball.net/projects/markdown/
+
 [reStructuredText]: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
+
 [MyST]: https://myst-parser.readthedocs.io/en/latest/

docs/requirements.txt

@@ -1,5 +1,7 @@
 # Requirements file for ReadTheDocs, check .readthedocs.yml.
 # To build the module reference correctly, make sure every external package
 # under `install_requires` in `setup.cfg` is also listed here!
+linkify-it-py
+myst-parser
+pydata-sphinx-theme
 sphinx>=3.2.1
-# sphinx_rtd_theme

setup.cfg

@@ -57,7 +57,6 @@ install_requires =
     tqdm
     typer
 
-
 [options.packages.find]
 where = src
 exclude =