Commit Graph

1250 Commits

Author SHA1 Message Date
Robert Raposa
fd584b70b6 Merge pull request #25681 from edx/robrap/capitalize-technical-reference-2
capitalize technical reference title
2020-12-01 12:22:57 -05:00
Manjinder Singh
d99070f68d docs: Clarifying pytest testing guide (#25668) 2020-12-01 09:48:30 -05:00
Diana Huang
1049c8c502 Clarify how to debug javascript tests in testing.rst. 2020-11-30 11:38:17 -05:00
Robert Raposa
10ce4af1ea capitalize technical reference title
Capitalize the title of the "edx-platform Technical Reference" documentation.
2020-11-24 16:59:52 -05:00
Sarina Canelake
18059c20e7 Merge pull request #25505 from edx/sarina/gender-neutral-language
Change gendered language to gender-neutral 'they/them/their'
2020-11-03 16:16:59 -05:00
Robert Raposa
64a162f69c Merge pull request #25494 from regisb/regisb/fix-swaggerdocs
[BD-21] Fix API docs generation and update swagger.yml
2020-11-03 11:40:29 -05:00
sarina
f414fad0cc Change gendered language to gender-neutral 'they/them/their' 2020-11-02 18:23:13 -05:00
Régis Behmo
3599198f19 Fix API docs generation and update swagger.yml
API docs generation was being blocked by missing values in the doc
settings. We wanted to update the swagger.yml to get the toggle state
("/toggles/v0/state/") endpoint in the docs.
2020-11-02 09:27:48 +01:00
Kyle McCormick
090e10683c Rename sys_path_hacks/ to import_shims/
The old folder name is somewhat confusing, because the
folder contains shims to _compensate for the removal
of sys.path hacks_, but does not contain the sys.path
hacks themselves.

Furthermore, this import_shims/ system could also be
used for other import path changes, such as turning
the locally-installed packages in common/lib/
into regular, importable modules
(e.g. `from common.lib.xmodule import abc` instead of
`from xmodule import abc`). So, a name that is not
specific to the sys.path hacks may be better
in the medium-to-long term.

Along the same lines, we also rename SysPathHackWarning
to DeprecatedEdxPlatformImportWarning.
2020-10-30 10:20:48 -04:00
Kyle McCormick
4847a18a66 Remove sys.path modification for Studio; use sys_path_hacks instead
Also, tweak the un_sys_path.sh script.
2020-10-19 09:34:31 -04:00
Jeremy Bowman
d19368525b DEPR-43 Remove most of the shoppingcart app (#24692)
Removed most of the deprecated shoppingcart app, leaving just enough to allow us to cleanly remove the related database tables later. Also removed the relevant Django settings that weren't in use elsewhere.
2020-10-14 14:24:52 -04:00
Robert Raposa
f65bf0ed9d Merge pull request #24794 from regisb/regisb/settings-docs
[BD-21] Document settings with annotations
2020-10-01 11:53:39 -04:00
Régis Behmo
a41f2a5ca8 Rename "featuretoggles" docs target to "technical"
We also split the feature toggle and settings docs in different pages.
2020-10-01 16:35:48 +02:00
Kyle McCormick
b82ac1fc16 Add sys_path_hacks/warn.py for easier modification of path warnings 2020-09-30 08:56:44 -04:00
Régis Behmo
e555d8a571 [BD-21] Document settings with annotations
We introduce the documentation of django settings via code annotations.
This will allow us to produce a human-readable documentatio of all Open
edX settings.
2020-09-28 12:44:36 +02:00
Calen Pennington
4a120a9e26 Fix failures caused by removing lms/djangoapps from sys.path 2020-09-23 10:05:37 -04:00
Calen Pennington
7cbfc8de40 Add an ADR capturing sys.path removal justifications 2020-09-23 10:05:37 -04:00
Gábor Boros
6ccd6c308d docs(lms and studio): Replace all .(lms|cms).(\w+|_)?\.json to .(lms|cms).(\w+|_)?\.yml 2020-09-18 10:44:14 +02:00
David Ormsbee
607400c403 ADR for the role of XBlock
Architecture Decision Record detailing the history of XBlock and
where we're going with it in the platform.
2020-08-26 10:37:37 -04:00
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
Manjinder Singh
c76ed6ae45 Extracting plugin app from edx-platform (#24678)
* Moving plugins infrastructure to edx-django-utils
This PR extracts the code that enables plugins in edx-platform and puts it in edx-django-utils. This is done to allow other IDAS to add plugin functionality.
2020-08-12 07:48:53 -04:00
Aarif
09ac7f9372 remove cyclomatic complexity calculation for python code 2020-08-04 22:10:05 +05:00
David Ormsbee
6d8fba77b2 ADR for LMS/Studio subdomain boundaries (TNL-7323)
Introduce an Architectural Decision Record about the boundaries
and responsibilities of Studio (Content Authoring) and the LMS
(Learning Experience). These are not new ideas. This is just
explicitly writing down the many local decisions that have been
made for years (Block Transformers, edx-when, grading, etc.), and
showing how they add together to a set of high level principles.

I hope to eventually have docs describing Studio/LMS's relation
to other subdomains in Open edX.
2020-07-11 13:05:18 -04:00
Braden MacDonald
831a90ebca Document the various integration points for platform extensions (#24057) 2020-06-10 17:22:32 -04:00
Ned Batchelder
cca33732ba Correct markup mistakes in api docs 2020-05-12 13:36:14 -04:00
Ned Batchelder
ac166306b3 Swagger.yaml is different due to DRF 3.9.x 2020-05-12 10:15:48 -04:00
Ned Batchelder
878b75191c Update docs_settings.py with latest settings 2020-05-11 14:21:15 -04:00
Feanil Patel
f95158458e Merge pull request #23888 from edx/feanil/update_bokchoy_adr
Bokchoy ADR Updates.
2020-05-05 15:16:42 -04:00
Feanil Patel
307986575e Make updates based on feedback. 2020-05-05 09:54:05 -04:00
Feanil Patel
55303e9233 Bokchoy ADR Updates. 2020-05-04 11:37:46 -04:00
Feanil Patel
c0f28a73ca Make updates to better match up with OEP-45 2020-04-30 11:51:33 -04:00
Feanil Patel
db8348f733 Added more info based on feedback. 2020-04-30 11:51:33 -04:00
Feanil Patel
27b699e5a1 An initial draft of a decision around how we manage settings files. 2020-04-30 11:51:33 -04:00
Robert Raposa
5de9eed420 ARCHBOM-1093: Fix unit test enable-migrations (#23789)
* fix old migrations
* fix a test
* fix enable-migrations cmd argument
* enhance verbose logging to log migrations
* update testing doc with help
2020-04-23 14:04:29 -04:00
Feanil Patel
98a657e849 Respond to feedback. 2020-03-25 12:23:46 -04:00
Feanil Patel
144982af8c Respond to PR feedback.
- Fix indenting.
- Small wording fixes.
2020-03-23 09:56:53 -04:00
Feanil Patel
d0f584ab7e Update based on feedback. 2020-03-19 16:12:23 -04:00
Feanil Patel
82c50458a1 Add a draft decision related to bokchoy experiment. 2020-03-19 10:57:14 -04:00
Alex Dusenbery
31498cc414 In canUserCreateTeam(), look in this.context.userInfo for staff/priveleged attributes. 2020-01-29 14:59:48 -05:00
Adam Butterworth
f0aa3daa87 Use Fullscreen API for video XBlock full screen mode (#22896)
[TNL-7051] Clicking a video XBlock's fullscreen button now takes the video fullscreen instead of full window.

Gracefully fallback to full window if fullscreen apis are absent
2020-01-24 09:48:41 -05:00
Ned Batchelder
079d17b899 Remove code that is now in edx_api_doc_tools 2020-01-21 11:15:41 -05:00
Manjinder Singh
ac232e926a Merge pull request #22645 from edx/msingh/fixing_type
Fixing typo
2020-01-01 21:26:16 -05:00
Feanil Patel
6e3fe00fff Fix all E303 pep8 errors. 2019-12-30 12:25:38 -05:00
Manjinder Singh
2a6517ad27 Fixing typo 2019-12-30 10:42:35 -05:00
Feanil Patel
9cf2f9f298 Run 2to3 -f future . -w
This will remove imports from __future__ that are no longer needed.

https://docs.python.org/3.5/library/2to3.html#2to3fixer-future
2019-12-30 10:35:30 -05:00
Ned Batchelder
1e8f8f7445 API docs: Show the TOC 2019-11-01 11:32:37 -04:00
Ned Batchelder
d71224e0a1 Use sphinxcontrib-openapi to do the heavy lifting of Open API rendering. 2019-10-22 17:45:28 -04:00
Régis Behmo
33bd0f953a Update swagger.yml 2019-10-14 08:14:08 +02:00
Ned Batchelder
cdac1f4abb Doc tooling for static API docs 2019-09-17 16:53:07 -04:00
Ned Batchelder
3b69fe0b47 Move existing docs down a level to make room for more 2019-07-23 08:31:15 -04:00