Commit Graph

8 Commits

Author SHA1 Message Date
Irtaza Akram
68a626a938 fix: replace autodoc with autoapi (#35846) 2024-11-18 10:16:09 +05:00
Feanil Patel
e644ade6df docs: Redirect all technical doc pages.
We publish the two pages that were being published under here to the new
edx-platform docs under docs.openedx.org so update this doc site to
redirect to that site for all pages.

Once this version has been published, we should be safe to remove this
doc project from the platform and all future changes should go through
the single edx-platform docs site.
2023-07-17 17:05:26 -04:00
Feanil Patel
376211950f build: Add base requirements to docs.
If we want to build autodocs from the code, we need the dependencies of
the code installed as a part of the docs build.
2023-07-17 10:49:44 -04:00
Feanil Patel
cee0e75566 docs: Add config for redirecting pages.
We want to be able to move pages around and have sphinx automatically
redirect to the now location when that happens.  This will allow us to
re-organize safely as we figure out the best way to layout the
documentation.
2023-07-13 12:10:11 -04:00
Feanil Patel
eba2856293 build: Re-org docs deps.
Some doc buildig deps were in development.in explicitly while others
weren't.  Update development.in to pull in doc.txt and then remove
direct additions of the doc requirements from development.in
2023-07-12 15:06:23 -04:00
Feanil Patel
0167b09a3b docs: Add the new sphinx-design extension.
This gives us the abuliity to add some nice responsive web components to
our docs. In particular girds and cards.
2023-07-12 15:05:15 -04:00
Kshitij Sobti
1c3c702583 chore: Switch from edx-sphinx-theme to sphinx-book-theme
The edx-sphinx theme is being deprecated, and replaced with sphinx-book-theme.
This removes references to the deprecated theme and replaces them with the new
standard theme for the platform.

See https://github.com/openedx/edx-sphinx-theme/issues/184
2023-04-28 09:16:09 +05:30
Robert Raposa
2c8105f7ae [BD-21] Generate feature toggle documentation
We introduce a new documentation target, where we use the featuretoggles
Sphinx extension from code-annotations to generate human-readable
documentation of feature toggles in edx-platform. The annotation report
is generated on-the-fly based on the standard feature toggle
configuration file in code-annotations.

In addition, we add new doc.in & doc.txt requirement files that will be
pip-installed by readthedocs to generate the documentation targets.
2020-08-14 19:41:26 +02:00