From d01808d3308bfc51bfbc9109427f4428a8f5b821 Mon Sep 17 00:00:00 2001 From: Alexander Helmboldt Date: Tue, 6 Jul 2021 18:24:12 +0200 Subject: [PATCH] Added links to RTD pages to 'README.md' and 'setup.cfg'; commented out 'html_theme' in 'conf.py' --- README.md | 6 +++--- docs/conf.py | 4 ++-- setup.cfg | 2 ++ 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2f06341..66e5414 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It extends the great [`django-import-export`](https://github.com/django-import-e Exporting data from Django's admin to Google Sheets is currently not supported but planned for a future release. Below, we briefly outline how to install and use the package. -A more detailed documentation about `django-gsheets-import` is available [here](#). +A more detailed documentation about `django-gsheets-import` is available [here](https://django-gsheets-import.readthedocs.io/en/latest/). @@ -23,7 +23,7 @@ INSTALLED_APPS = [ ] ``` In order for `django-gsheets-import` to work properly, it needs to be associated with an underlying **Google Cloud Project** (GCP). -How to properly set up an appropriate GCP using the Google Cloud Console is described in more detail in the corresponding section of our documentation. +How to properly set up an appropriate GCP using the Google Cloud Console is described in more detail in the corresponding section of our [documentation](https://django-gsheets-import.readthedocs.io/en/latest/user_manual/google_cloud_project.html). At this point, let us just note that all of the services needed are available in Google Cloud's [Free Tier](https://cloud.google.com/free/), so that there is no need to set up a billing account. Assuming that a suitable GCP already exists, go to the [Google Cloud Console](https://console.cloud.google.com/) and navigate to `APIs & Services > Credentials`. From there, copy an **API key**, as well as the desired **OAuth Client ID** and add them to your `settings.py`. @@ -43,7 +43,7 @@ The package is now ready to be used with your Django project. The `django-gsheets-import` package presented here strongly relies on the functionality provided by the `django-import-export` package. It extends that package by the option to allow the user to import data from their Google Sheets via the Django admin. The usage of `django-gsheets-import` is very similar to that of `django-import-export`, which is nicely documented [here](https://django-import-export.readthedocs.io/en/latest/). -It might also be instructive to have a look at the example Django project that ships with `django-gsheets-import` (see below). +It might also be instructive to have a look at the example Django project that ships with `django-gsheets-import` (see the [documentation](https://django-gsheets-import.readthedocs.io/en/latest/user_manual/demo_app.html) for more details). In short, integrating the Google Sheets import feature offered by `django-gsheets-import` into your Django project's admin site is a two-step process: diff --git a/docs/conf.py b/docs/conf.py index 7e1947f..de79324 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,9 +47,9 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +#html_theme = 'alabaster' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ['_static'] diff --git a/setup.cfg b/setup.cfg index ad0c348..2b4f459 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,6 +10,8 @@ license = BSD-2-Clause url = https://github.com/kenkuhhaut/django-gsheets-import project_urls = Bug Tracker = https://github.com/kenkuhhaut/django-gsheets-import/issues + Documentation = https://django-gsheets-import.readthedocs.io/en/latest/ + Source Code = https://github.com/kenkuhhaut/django-gsheets-import classifiers = Development Status :: 3 - Alpha Topic :: Software Development