Skip to content

Commit

Permalink
Update Read the Docs configuration (#263)
Browse files Browse the repository at this point in the history
* Add Read the Docs config file

* Update quickstart

* Add requirements

* Pin all dependencies

* Update install stanza
  • Loading branch information
bennylope authored Nov 23, 2023
1 parent 7a11ce6 commit 4fc94c2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 17 deletions.
16 changes: 16 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

sphinx:
configuration: docs/conf.py

python:
install:
- method: pip
path: .
extra_requirements:
- docs
5 changes: 3 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from organizations import __version__

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down Expand Up @@ -46,9 +47,9 @@
# built documents.
#
# The short X.Y version.
version = "2.2"
version = ".".join(__version__.split(".")[:2])
# The full version, including alpha/beta/rc tags.
release = "2.2.0"
release = __version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
22 changes: 7 additions & 15 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,15 @@ First add the application to your Python path. The easiest way is to use

pip install django-organizations

Upgrading Django for existing installations
-------------------------------------------
Quickstart Configuration
========================

If you are upgrading the Django version of an existing deployment that
deprecates South in favor of Django's native migrations, you will need to fake
the migrations for Django Organizations (if you have installed the app
directly, of course).
.. note::

Configuration
=============
If however you want to use single-table customized organization models and/or
custom *organization user* models, it may be best to treat Django organizations
as a library and *not* install it in your Django project. See the
:ref:`cookbook-advanced` section.

Ensure that you have a user system in place to connect to your organizations.

Expand All @@ -52,13 +51,6 @@ settings file.::
This should work for the majority of cases, from either simple, out-of-the-box
installations to custom organization models.

.. note::

If however you want to use single-table customized organization models and/or
custom *organization user* models, it may be best to treat Django organizations
as a library and *not* install it in your Django project. See the
:ref:`cookbook-advanced` section.

URLs
----

Expand Down

0 comments on commit 4fc94c2

Please sign in to comment.