Sphinx tries to explore all the defined objects when trying to generate
docs from the code. When it tries to introspect the QuerySet object, it
results in that object trying to query the database which we don't
really want to setup for a docs build as it's not relevant and fairly
expensive to do. To circumvent this issue, we add a new filter to the
docs build that essentially skips further introspection of QuerySet
objects.
To build some of the docs dynamically, a new virtualenv is created.
Without this ignore, sphinx also reads all the files under that tree and
then complains that they're not properly linked to the rest of the docs.
In the context of edx-platform django settings,
devstack_docker is an alias to devstack. Both
are deprecated, technically, but we currently
want to remove all devstack-related settings files
except devstack.py (which tutor still uses). So,
in order to remove devstack_docker.py, we update
its references to devstack.py
Now that the content in `guides` is all of the edx-platform docs, move
them all into the top-level docs directory to reduce confusion.
BREAKING CHANGE: Guides are now just docs. This will require updating
the publishing settings so that RTD looks for the conf in a different
location.
This is part of a larger effort to split packages out into independent,
composable, PyPI installable Python packages.
While this package itself isn't monumental, it represents the bottom of
the dependecy tree and can be split out before any other packages.