Tiansu add readthedocs.yml (#27)

* add .readthedocs.yml * remove dependencies * update entity and README * add squirrel-datasets link * correct link
merantix-momentum · Apr 5, 2022 · cdcca36 · cdcca36
1 parent d0ba36e
commit cdcca36
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 32 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,21 @@
+# .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 version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.8"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+#python:
+#   install:
+#   - requirements: requirements.txt
diff --git a/README.md b/README.md
@@ -38,38 +38,14 @@ it = (Catalog.from_plugins()["imagenet"].get_driver()
 Check out our full [getting started](https://github.com/merantix-momentum/squirrel-datasets-core/blob/main/examples/01.Getting_Started.ipynb) tutorial notebook. If you have any questions or would like to contribute, join our [Slack community](https://join.slack.com/t/squirrel-core/shared_invite/zt-14k6sk6sw-zQPHfqAI8Xq5WYd~UqgNFw).
 
 # Installation
-Currently, we have not released a functional version of `squirrel-core` and `squirrel-datasets-core` into the public 
-pypi registry. Therefore we ask you to use the following installation method, which uses the source code directly:
-
-First, you need to clone the `squirrel-core` and `squirrel-datasets-core` repositories by:
-```shell
-git clone https://github.com/merantix-momentum/squirrel-core.git
-```
-and 
-```shell
-git clone https://github.com/merantix-momentum/squirrel-datasets-core.git
-```
-Then you can install both packages by
+You can install `squirrel-core` by 
 ```shell
-pip install -e "squirrel-core[all]"
+pip install "squirrel-core[all]"
 ```
-and
-```shell
-pip install -e "squirrel-datasets-core[all]"
-```
-
-In the documentation, you may also see some requirements to install the two packages first, please follow the 
-instruction above, instead of installing from public pypi registry (e.g `pip install squirrel-core` or 
-`pip install squirrel-datasets-core`). We kindly ask for your patience.
 
 # Documentation
 
-To view the docs locally, please use the following command in root directory of the repo:
-```
-sphinx-build ./docs ./docs/build
-```
-The command above will create all documentation pages under `./docs/build`.
-To view the start page, open `./docs/build/index.html` in your browser. 
+Read our documentation at [ReadTheDocs](https://squirrel-core.readthedocs.io/)
 
 # Example Notebooks
 Check out the [Squirrel-datasets repository](https://github.com/merantix-momentum/squirrel-datasets-core/tree/main/examples) for open source and community-contributed tutorial and example notebooks of using Squirrel.

diff --git a/docs/conf.py b/docs/conf.py
@@ -28,8 +28,8 @@
 # -- Project information -----------------------------------------------------
 
 project = "Squirrel"
-copyright = f"{datetime.datetime.now().year}, Merantix Labs GmbH"
-author = "Merantix Labs GmbH"
+copyright = f"{datetime.datetime.now().year}, Merantix Momentum"
+author = "Merantix Momentum"
 
 
 # -- General configuration ---------------------------------------------------
@@ -73,7 +73,7 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
     "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
-    # TODO Add squirrel-datasets once the RTD is online.
+    "squirrel-datasets": ("https://squirrel-datasets-core.readthedocs.io", None),
 }
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/requirements.dev.in b/requirements.dev.in
@@ -7,7 +7,7 @@ pytest-xdist
 Sphinx<4.0.0
 sphinx_versions
 sphinx_rtd_theme
+sphinx-autoapi
 wandb
 mlflow
 pre-commit==2.16.0
-sphinx-autoapi
diff --git a/setup.py b/setup.py
@@ -129,7 +129,7 @@ def normalize_version(_version: str, _version_tag: str) -> str:
         ),
         long_description=long_description,
         long_description_content_type="text/markdown",
-        author="Merantix Labs GmbH",
+        author="Merantix Momentum",
         license="Apache 2.0",
         package_dir=PACKAGE_DIR,
         packages=find_packages(),