17 Commits

Author SHA1 Message Date
Feanil Patel
8143796b26 docs: update references from setup.py to pyproject.toml
Update documentation, comments, and docstrings throughout the codebase
to reflect the migration from setup.py to pyproject.toml:

- Transformer class docstrings: changed to reference "entry point name
  in the package configuration" for better future-proofing
- Block structure module docs: updated to reference pyproject.toml
- Test file comments: updated entry point references
- Config files (tox.ini, pytest.ini): updated references
- Documentation (extension_points.rst, course apps ADRs): updated to
  reference pyproject.toml with inclusive language for external packages
- Requirements documentation (github.in): updated with inclusive language
- edxmako README: modernized install command to use pip install

Historical ADRs and references to external packages that may still use
setup.py were intentionally left unchanged or updated with inclusive
language acknowledging both pyproject.toml and setup.py.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-03-03 10:46:16 -05:00
Kyle McCormick
c70bfe980a build!: Switch to openedx-core (renamed from openedx-learning) (#38011)
build!: Switch to openedx-core (renamed from openedx-learning)

Instead of installing openedx-learning==0.32.0, we install openedx-core==0.34.1.
We update various class names, function names, docstrings, and comments to
represent the rename:

* We say "openedx-core" when referring to the whole repo or PyPI project
  * or occasionally "Open edX Core" if we want it to look nice in the docs.
* We say "openedx_content" to refer to the Content API within openedx-core,
   which is actually the thing we have been calling "Learning Core" all along.
  * In snake-case code, it's `*_openedx_content_*`.
  * In camel-case code, it's `*OpenedXContent*`

For consistency's sake we avoid anything else like oex_core, OeXCore,
OpenEdXCore, OexContent, openedx-content, OpenEdxContent, etc.
There should be no more references to learning_core, learning-core, Learning Core,
Learning-Core, LC, openedx-learning, openedx_learning, etc.

BREAKING CHANGE: for openedx-learning/openedx-core developers:
You may need to uninstall openedx-learning and re-install openedx-core
from your venv. If running tutor, you may need to un-mount openedx-learning,
rename the directory to openedx-core, re-mount it, and re-build.
The code APIs themselves are fully backwards-compatible.

Part of: https://github.com/openedx/openedx-core/issues/470
2026-02-18 22:38:25 +00:00
sarina
1e3074a3f9 docs: Update edx.rtd.io links to docs.openedx.org 2025-04-02 12:10:56 -04:00
Robert Raposa
399be67fc4 style: remove eslint with frontend code removal ADR
- Add ADR for frontend code removal
- Drop eslint, as explained in the ADR
2025-03-20 11:03:41 -04:00
Feanil Patel
43624fd922 fix: Dropping terrain related config and docs.
The terrain app and its stub servers were removed as a part of
https://github.com/openedx/edx-platform/pull/36102 but these last few
things got missed.
2025-01-17 09:04:48 -05:00
Kyle D. McCormick
41d28f3ce3 docs: Turn old static asset plan into a retroactive ADR 2024-12-18 11:26:49 -05:00
Kyle D. McCormick
4c0d94e367 docs: Update testing guide 2024-12-18 11:26:49 -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
Kyle McCormick
15caa9746f refactor: Completely remove Blockstore (#34739)
Blockstore and all of its (experimental) functionality has been replaced with
openedx-learning, aka "Learning Core". This commit uninstalls the now-unused
openedx-blockstore package and removes all dangling references to it.

Note: This also removes the `copy_library_from_v1_to_v2` management command,
which has been broken ever since we switched from Blockstore to Learning Core.

Part of this DEPR: https://github.com/openedx/public-engineering/issues/238
2024-05-13 09:48:18 -04:00
connorhaugh
b0a004de33 docs: add pytest django setting specification to docs (#33564) 2023-10-24 11:35:15 -04:00
Andy Shultz
3d00f5a276 docs: also paver test no longer exists, remove it
paver for js test is discussed below separately

python testing is covered well in the next section, running all python
tests is not useful for development loops
2023-09-28 14:22:04 -04:00
Andy Shultz
609629c6d3 docs: actually pull the eye to the most weird and critical instruction 2023-09-28 13:54:42 -04:00
Feanil Patel
df5759ca37 docs: Make the docs easier to read and and some links. 2023-08-17 11:11:59 -04:00
Feanil Patel
5a1abcb64f fixup! docs: Add some basic docs on the Rest API. 2023-08-17 10:47:56 -04:00
Feanil Patel
88096cc54d docs: Add more examples related to Auth. 2023-08-17 10:30:06 -04:00
Feanil Patel
e663988c10 docs: Add some basic docs on the Rest API.
There is probably a lot more to say but add a quick How-To and concept
docs that we can build on.
2023-08-16 15:35:06 -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