From c3f6a86ce006d54baf847254379586c77cc9b2e5 Mon Sep 17 00:00:00 2001 From: TiansuYu Date: Tue, 5 Apr 2022 11:33:29 +0200 Subject: [PATCH 1/5] add .readthedocs.yml --- .readthedocs.yml | 21 +++++++++++++++++++++ requirements.dev.in | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..0f1ea5ef --- /dev/null +++ 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/requirements.dev.in b/requirements.dev.in index 9e9aac92..1ff27ffa 100644 --- 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 From d6d92231ac5621e4829c77772e95379d495a02e5 Mon Sep 17 00:00:00 2001 From: TiansuYu Date: Tue, 5 Apr 2022 12:34:10 +0200 Subject: [PATCH 2/5] remove dependencies --- .readthedocs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 0f1ea5ef..08e7f9df 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -16,6 +16,6 @@ sphinx: configuration: docs/conf.py # Optionally declare the Python requirements required to build your docs -python: - install: - - requirements: requirements.txt +#python: +# install: +# - requirements: requirements.txt From e89a58497b5cb2d83460bb3e689ad5781df845af Mon Sep 17 00:00:00 2001 From: TiansuYu Date: Tue, 5 Apr 2022 12:46:05 +0200 Subject: [PATCH 3/5] update entity and README --- README.md | 30 +++--------------------------- docs/conf.py | 4 ++-- setup.py | 2 +- 3 files changed, 6 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 41c4bee9..5f13692e 100644 --- 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.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 index a8588147..02a02e80 100644 --- 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 --------------------------------------------------- diff --git a/setup.py b/setup.py index b9d40d43..a08083a0 100644 --- 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(), From 4733c022ab0e2b683d23f1d1b4ab654be3d40b4c Mon Sep 17 00:00:00 2001 From: TiansuYu Date: Tue, 5 Apr 2022 12:47:16 +0200 Subject: [PATCH 4/5] add squirrel-datasets link --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 02a02e80..9a2f3dca 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 ------------------------------------------------- From 8a67cd99fdf09372eae496390e7abdea1db36194 Mon Sep 17 00:00:00 2001 From: TiansuYu Date: Tue, 5 Apr 2022 12:49:10 +0200 Subject: [PATCH 5/5] correct link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f13692e..406cfa61 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ pip install "squirrel-core[all]" # Documentation -Read our documentation at [ReadTheDocs](https://squirrel.readthedocs.io/) +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.