Commit Graph

1231 Commits

Author SHA1 Message Date
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
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
Andytr1
10cf20235b Update testing.rst 2019-05-31 09:23:20 -04:00
Jeremy Bowman
f9929f32b5 Update quality threshold counts (#20681) 2019-05-24 08:27:54 -04:00
Nimisha Asthagiri
a943a2cb63 Top-level ADR-2: Inter-App APIs 2019-05-04 11:00:15 -04:00
Nimisha Asthagiri
2e549c0545 Top-level ADR-1: Courses in LMS
Refactored the previous best-practices document as an ADR.
Previous document: 07f588517b/docs/best_practices.rst
2019-05-04 10:22:36 -04:00
Nimisha Asthagiri
4d66633d78 testing.rst: update regarding acceptance tests 2019-05-04 10:22:35 -04:00
Nimisha Asthagiri
7f3727d84f Refactor top-level docs directory 2019-05-04 10:22:35 -04:00
Feanil Patel
67db3155ff Merge pull request #20101 from stvstnfrd/split-core/calc
Split calc package out into an independent package
2019-05-03 15:59:27 -04:00
Nimisha Asthagiri
dfa3728edf Move django_comment_common from common to openedx 2019-05-03 12:10:18 -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
Nimisha Asthagiri
ef0e06cc0a Revert "Discussions consolidation" 2019-05-02 14:59:56 -04:00
Nimisha Asthagiri
df962a31b7 Move django_comment_common to openedx/core/djangoapps/discussion_common 2019-05-01 19:15:02 -04:00
Jeremy Bowman
34a0bd91e8 TE-2850 Resume RTD doc builds (#19910) 2019-04-18 15:41:13 -04:00
Michael Youngstrom
bfe10720c6 Remove lettuce infrastructure 2019-04-18 09:58:21 -04:00
Alex Dusenbery
ac38d5b413 Create a local .coveragerc file, update testing docs. 2019-03-12 10:05:04 -04:00
Loic Dachary
09c2820feb docs: s/javascript/JavaScript/ 2019-02-05 12:46:25 +01:00
Michael Youngstrom
78d9892319 Add script to get test list for failed worker 2018-10-30 12:47:56 -04:00
Jeremy Bowman
713d64e1e2 TE-2702 Update Read the Docs links to HTTPS 2018-08-15 17:34:01 -04:00
Mick Timony
48ce7669aa Update documentation links that return 404 errors. 2018-06-22 09:28:21 -04:00