Commit Graph

19 Commits

Author SHA1 Message Date
Feanil Patel
4a3e78e05f build: Don't try to read the database when building docs.
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.
2026-01-21 16:22:07 -05:00
Feanil Patel
02db4874f0 docs: Ignore a venv generated during docs build.
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.
2026-01-12 13:13:54 -05:00
Kyle McCormick
7a77652cd6 fix: devstack_docker -> devstack
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
2025-07-22 10:27:50 -04:00
Feanil Patel
18fe2976c7 build: We don't need to override this setting.
The format of the `source_suffix` setting has change but the default is
fine for us so we don't need to override this.
2025-02-14 15:51:24 -05:00
Maria Grimaldi
f96f92677f chore: [FC-0074] drop hooks docs in favor of latest in docs.openedx.org (#35921) 2024-12-11 19:22:57 +01:00
Irtaza Akram
0dd9f8f996 fix: disabling autoapi (#35939) 2024-12-06 18:58:50 +05:00
Irtaza Akram
68a626a938 fix: replace autodoc with autoapi (#35846) 2024-11-18 10:16:09 +05:00
Feanil Patel
999731e94a docs: Fix links to extensions docs.
The extensions docs did not get linked from the index previously. Add
them to the docs tree to make them easier to find.
2024-09-30 15:25:45 -04:00
Feanil Patel
740921ae21 build: Manually pull some RTD Context.
See https://about.readthedocs.com/blog/2024/07/addons-by-default/ for details but
essentially RTD is changing how it's building docs and this will let us handle the
change gracefully.
2024-09-26 11:29:40 -04:00
Muhammad Farhan Khan
d3d3225fa6 Move user-retirement scripts docs near code (#34695)
* chore: Move user-retirement scripts docs near code

---------

Co-authored-by: Feanil Patel <feanil@axim.org>
2024-05-07 14:45:04 -04:00
farhan
6c4170b407 feat: Add repository rst files in the sphinx docs 2024-04-26 12:56:53 +05:00
farhan
98dfb6d873 docs: Makes some improvements in the docs 2023-09-01 17:53:28 +05:00
Feanil Patel
f32c938961 fix: Update conf paths to match the new docs layout. 2023-07-18 15:41:34 -04:00
Feanil Patel
3e2d78b37b feat!: Move the docs out of the guides subdirectory.
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.
2023-07-18 14:31:49 -04:00
Ned Batchelder
3b69fe0b47 Move existing docs down a level to make room for more 2019-07-23 08:31:15 -04:00
stv
488e4e1e02 Remove local copy of openedx-chem package
now that we install it from an external repository.
2019-06-21 11:49:31 -07:00
Jeremy Bowman
f9929f32b5 Update quality threshold counts (#20681) 2019-05-24 08:27:54 -04:00
stv
e72967e349 Split calc package out into an independent package
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.
2019-05-02 15:26:02 -07:00
Jeremy Bowman
34a0bd91e8 TE-2850 Resume RTD doc builds (#19910) 2019-04-18 15:41:13 -04:00