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.
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.
We ran into memory issues at RTD so skip the xmodule, cms and common
docs for now so we can get some of the stuff up. We can come back to it
later once we make things better.
Since we want to replace the existing technical docs with this guides
project and we already build the technical docs into this project now.
Adding these redirects will allow it to be a drop-in replacement for the
existing published technical docs project.
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.
There is still a lot of improvements that could be made to make the
generated docs better organized. However, before this change we were
generating the docs but they weren't in the doc tree so you couldn't
actually browse to them. So we fix that first so that we can start
getting feedback about how to organize them.
This adds the ability to get a list of detailed courses based on their
keys provided in the newly added `keys` query param in the `GET /courses/v1/courses/`
endpoint.
With this move we don't need the existing separate `edx-platform
Technical` sphinx project. In the future we can remove it and just
redirect to the content in this project but I won't be doing that as a
part of this change because that involves adding redirects over there to
the new content and I'm not yet done organizing the destination.
The docs in the `guide` project might move around as we make the project
follow diataxis more closely.
* Swagger was renamed to OpenAPI at some point so use the new name for
clarity.
* Prefix with `lms` to make it clear that these are the APIs from the
LMS and may not all be available in the CMS.
* This project was not being published anywhere.
* The previous commit that adds openapi generation capabilities to the
`docs/guides` replaces what this was doing.
We get about one email per month from people looking for access to edX
APIs. Those emails come to the now almost-defunct oscm@edx.org email
address. I think that's because of these swagger references.
I suppose someone could find this email address on an Open edX
installation, and people would write to it, but I find in practice this
doesn't happen.
Co-authored-by: Kyle McCormick <kyle@tcril.org>
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
The ideas here are good and in line with OEP-45, but we have not
yet had a chance to implement them in edx-platform
Furthermore, recent conversations have made us consider
revisiting the "Don't use YAML files, just python modules"
alternative described in the ADR. Particularly, Tutor has
not been able to use pure YAML to configure edx-platform,
and has fallen back on having separate .py settings files.
This makes us think that we either need to expose
more power through the YAML interface, or we need to
re-embrace .py settings files.
feat: Enable Certificate Display Behavior add certificate_available_date in course detail API
fix: reviwed changes, certificate_available_date in Course Detail API but not in Course List API
fix: reviewed changes, certificate available date display condition updated
fix: final reviewed changes
fix: serializer and linting tests
fix: serializer and tests
fix: docstring
fix: docstring and tests
fix: typo and mock call
* feat: adds VerticalBlockChildrenLoaded filter call
This introduces the VerticalBlockChildrenLoaded filter that is run after
all the child blocks are fetched before rendering a student or the
public view. This will allow modifying the contents of the VerticalBlock
before presenting it to the students.
- Remove pylint warning suppression from SHAKE-128 hexdigest calls; these
are no longer needed as of astroid 2.12.12. For background, see issue
<https://github.com/PyCQA/pylint/issues/4039>. Also, correct a comment
that referred to SHAKE-256 instead of SHAKE-128.
- Replace "released" with "beta" in several places where there was a copy
& paste error in dark_lang. Add mention of `beta_lang` to a docstring
where it was omitted.
- Remove comment regarding Mongo startup; the code it referred to has since
been removed.
- Fix typos.
Adds new api to return block metadata which includes index_dictionary.
Reason for new api instead of adding it to course blocks API: data like
index_dictionary are too large for the cache used by course/blocks
transformers API.
This commit adds a openedx-filters hook to the VerticalBlock XBlock
before rendering of it's children. This allows Open edX plugins to
customize the presentation of specific blocks based on the context.
As part of dissolving our sub-projects in edx-platform, we are moving this package under the xmodule directory.
We have fixed all the occurences of import of this package and also fixed all documents related references.
This might break your platform if you have any reference of `import capa` or `from capa import` in your codebase or in any Xblock.
Ref: https://openedx.atlassian.net/browse/BOM-2582
