From 4e7d928b6188c26d1df36fb774e255e1bba76728 Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Wed, 1 Nov 2023 17:36:52 -0400 Subject: [PATCH] build: Remove .. include:: ../../../links/links.rst from tutorial docs --- docs/xblock-tutorial/anatomy/html.rst | 2 -- docs/xblock-tutorial/anatomy/index.rst | 2 -- docs/xblock-tutorial/anatomy/javascript.rst | 2 -- docs/xblock-tutorial/anatomy/python.rst | 2 -- docs/xblock-tutorial/anatomy/stylesheets.rst | 2 -- docs/xblock-tutorial/concepts/children.rst | 2 -- docs/xblock-tutorial/concepts/events.rst | 2 -- docs/xblock-tutorial/concepts/fields.rst | 2 -- docs/xblock-tutorial/concepts/fragments.rst | 2 -- docs/xblock-tutorial/concepts/index.rst | 4 ++-- docs/xblock-tutorial/concepts/methods.rst | 7 ++----- docs/xblock-tutorial/concepts/runtimes.rst | 5 ++--- docs/xblock-tutorial/customize/custom-html.rst | 2 -- docs/xblock-tutorial/customize/custom-javascript.rst | 2 -- docs/xblock-tutorial/customize/custom-python.rst | 2 -- docs/xblock-tutorial/customize/custom-stylesheets.rst | 2 -- docs/xblock-tutorial/customize/index.rst | 2 -- docs/xblock-tutorial/edx_platform/devstack.rst | 2 -- docs/xblock-tutorial/edx_platform/edx.rst | 2 -- docs/xblock-tutorial/edx_platform/edx_lms.rst | 2 -- docs/xblock-tutorial/edx_platform/edx_studio.rst | 3 --- docs/xblock-tutorial/front_matter/index.rst | 4 ++-- docs/xblock-tutorial/front_matter/read_me.rst | 3 --- .../getting_started/create_first_xblock.rst | 2 -- docs/xblock-tutorial/getting_started/prereqs.rst | 2 -- docs/xblock-tutorial/getting_started/setup_sdk.rst | 2 -- docs/xblock-tutorial/overview/examples.rst | 2 -- docs/xblock-tutorial/overview/introduction.rst | 11 ++++------- docs/xblock-tutorial/sdk/get_started_sdk.rst | 2 -- 29 files changed, 12 insertions(+), 69 deletions(-) diff --git a/docs/xblock-tutorial/anatomy/html.rst b/docs/xblock-tutorial/anatomy/html.rst index c57f2d2a6..51b17cc07 100644 --- a/docs/xblock-tutorial/anatomy/html.rst +++ b/docs/xblock-tutorial/anatomy/html.rst @@ -25,5 +25,3 @@ Note the following details about the HTML file. * The values ``self.upvotes`` and ``self.downvotes`` reference the fields in the XBlock Python class. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/anatomy/index.rst b/docs/xblock-tutorial/anatomy/index.rst index e8710504f..e34f64978 100644 --- a/docs/xblock-tutorial/anatomy/index.rst +++ b/docs/xblock-tutorial/anatomy/index.rst @@ -20,5 +20,3 @@ example Thumbs XBlocK, see :ref:`Customize Your XBlock`. html javascript stylesheets - -.. include:: ../../../links/links.rst \ No newline at end of file diff --git a/docs/xblock-tutorial/anatomy/javascript.rst b/docs/xblock-tutorial/anatomy/javascript.rst index a44012bb2..fc13a6bbb 100644 --- a/docs/xblock-tutorial/anatomy/javascript.rst +++ b/docs/xblock-tutorial/anatomy/javascript.rst @@ -44,5 +44,3 @@ Note the following details about the JavaScript file. The XBlock JavaScript code can also use the ``children`` and ``childMap`` functions as needed. For more information, see :ref:`XBlock Children`. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/anatomy/python.rst b/docs/xblock-tutorial/anatomy/python.rst index f1bffaf98..6e7b52bf3 100644 --- a/docs/xblock-tutorial/anatomy/python.rst +++ b/docs/xblock-tutorial/anatomy/python.rst @@ -92,5 +92,3 @@ Note the following details about the vote handler. * The updated ``upvotes`` and ``downvotes`` fields are returned. For more information, see :ref:`Handler Methods`. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/anatomy/stylesheets.rst b/docs/xblock-tutorial/anatomy/stylesheets.rst index c2e12ce84..ba1e95e73 100644 --- a/docs/xblock-tutorial/anatomy/stylesheets.rst +++ b/docs/xblock-tutorial/anatomy/stylesheets.rst @@ -18,5 +18,3 @@ application. The styles in ``thumbs.css`` are referenced in the :ref:`XBlock HTML file `. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/concepts/children.rst b/docs/xblock-tutorial/concepts/children.rst index 915fa7775..0cf46bd49 100644 --- a/docs/xblock-tutorial/concepts/children.rst +++ b/docs/xblock-tutorial/concepts/children.rst @@ -70,5 +70,3 @@ following methods. element that has a specific name. .. examples? - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/concepts/events.rst b/docs/xblock-tutorial/concepts/events.rst index 1da997907..13c47ea08 100644 --- a/docs/xblock-tutorial/concepts/events.rst +++ b/docs/xblock-tutorial/concepts/events.rst @@ -102,5 +102,3 @@ have a ``has_score`` variable set to ``True``. .. code-block:: python has_score = True - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/concepts/fields.rst b/docs/xblock-tutorial/concepts/fields.rst index 0948bd38c..9a7831130 100644 --- a/docs/xblock-tutorial/concepts/fields.rst +++ b/docs/xblock-tutorial/concepts/fields.rst @@ -271,5 +271,3 @@ Default Fields in a New XBlock When you create a new XBlock, the ``count`` field is added to the Python file by default. This field is for demonstration purposes and you should replace it with your own field definitions. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/concepts/fragments.rst b/docs/xblock-tutorial/concepts/fragments.rst index 0e4494b07..c1b74d573 100644 --- a/docs/xblock-tutorial/concepts/fragments.rst +++ b/docs/xblock-tutorial/concepts/fragments.rst @@ -100,5 +100,3 @@ CSS strings generated from the XBlock's static files. ******************** TBP - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/concepts/index.rst b/docs/xblock-tutorial/concepts/index.rst index e233a9baf..b333c7350 100644 --- a/docs/xblock-tutorial/concepts/index.rst +++ b/docs/xblock-tutorial/concepts/index.rst @@ -1,8 +1,8 @@ .. _XBlock Concepts: -#################### +############### XBlock Concepts -#################### +############### You build XBlocks that course teams use to create independent course components that work seamlessly with other components in an online course. For example, diff --git a/docs/xblock-tutorial/concepts/methods.rst b/docs/xblock-tutorial/concepts/methods.rst index dee32e434..33bed1291 100644 --- a/docs/xblock-tutorial/concepts/methods.rst +++ b/docs/xblock-tutorial/concepts/methods.rst @@ -1,8 +1,8 @@ .. _XBlock Methods: -#################### +############## XBlock Methods -#################### +############## You use XBlock methods in the XBlock Python file to define the behavior of your XBlock. @@ -111,6 +111,3 @@ When you create a new XBlock, two methods are added automatically. * The handler method ``increment_count``. This method is for demonstration purposes and you can remove it. - - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/concepts/runtimes.rst b/docs/xblock-tutorial/concepts/runtimes.rst index deaf54ad2..8c23db725 100644 --- a/docs/xblock-tutorial/concepts/runtimes.rst +++ b/docs/xblock-tutorial/concepts/runtimes.rst @@ -1,8 +1,8 @@ .. _XBlock Runtimes: -#################### +############### XBlock Runtimes -#################### +############### An XBlock runtime is the application that hosts XBlock. For example, the XBlock SDK, the :ref:`edX LMS `, @@ -182,4 +182,3 @@ For more information, see `XBlock Runtime API`_ in the *XBlock API Guide*. .. _XBlock Runtime API: http://edx.readthedocs.io/projects/xblock/en/latest/ -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/customize/custom-html.rst b/docs/xblock-tutorial/customize/custom-html.rst index 6ca7dc576..27c75e97c 100644 --- a/docs/xblock-tutorial/customize/custom-html.rst +++ b/docs/xblock-tutorial/customize/custom-html.rst @@ -72,5 +72,3 @@ Next Step After you complete your customizations to the HTML file, you continue on and :ref:`customize the XBlock JavaScript file`. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/customize/custom-javascript.rst b/docs/xblock-tutorial/customize/custom-javascript.rst index 1eddf8319..a69c9c00d 100644 --- a/docs/xblock-tutorial/customize/custom-javascript.rst +++ b/docs/xblock-tutorial/customize/custom-javascript.rst @@ -75,5 +75,3 @@ Next Step After you complete your customizations to the JavaScript file, you continue on and :ref:`customize the XBlock CSS file`. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/customize/custom-python.rst b/docs/xblock-tutorial/customize/custom-python.rst index bbaa0412a..854235490 100644 --- a/docs/xblock-tutorial/customize/custom-python.rst +++ b/docs/xblock-tutorial/customize/custom-python.rst @@ -168,5 +168,3 @@ Next Step After you complete your customizations to the Python file, you continue on and :ref:`customize the XBlock HTML file`. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/customize/custom-stylesheets.rst b/docs/xblock-tutorial/customize/custom-stylesheets.rst index 9f46fc9ef..94b4e0d9a 100644 --- a/docs/xblock-tutorial/customize/custom-stylesheets.rst +++ b/docs/xblock-tutorial/customize/custom-stylesheets.rst @@ -62,5 +62,3 @@ matches the code in the Thumbs XBlock. The styles in ``thumbs.css`` are referenced in the :ref:`XBlock HTML file `. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/customize/index.rst b/docs/xblock-tutorial/customize/index.rst index d80ebaaad..d0002328a 100644 --- a/docs/xblock-tutorial/customize/index.rst +++ b/docs/xblock-tutorial/customize/index.rst @@ -21,5 +21,3 @@ For more information about the different components of an XBlock, see custom-html custom-javascript custom-stylesheets - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/edx_platform/devstack.rst b/docs/xblock-tutorial/edx_platform/devstack.rst index 3b1a37d03..a74c19085 100644 --- a/docs/xblock-tutorial/edx_platform/devstack.rst +++ b/docs/xblock-tutorial/edx_platform/devstack.rst @@ -120,5 +120,3 @@ You can then edit the properties of the instance as needed by selecting the For more information about working with components in Studio, see :ref:`opencoursestaff:Developing Course Components` in the *Building and Running an Open edX* guide. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/edx_platform/edx.rst b/docs/xblock-tutorial/edx_platform/edx.rst index 02ae75d9a..43316f7d1 100644 --- a/docs/xblock-tutorial/edx_platform/edx.rst +++ b/docs/xblock-tutorial/edx_platform/edx.rst @@ -35,5 +35,3 @@ After you submit the pull request, edX will review your XBlock to ensure that it is appropriate for use on edx.org. Specifically, edX will review your XBlock for security, scalability, accessibility, and fitness of purpose. You should be prepared to respond to questions and comments from edX in your pull request. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/edx_platform/edx_lms.rst b/docs/xblock-tutorial/edx_platform/edx_lms.rst index 5c3306010..f5926221a 100644 --- a/docs/xblock-tutorial/edx_platform/edx_lms.rst +++ b/docs/xblock-tutorial/edx_platform/edx_lms.rst @@ -172,5 +172,3 @@ in order to observe the translated strings for your chosen locale. internationalization support. There is no guarantee your strings will be matched by the LMS, and even if matches are found, the translations may be incorrect in the context of your specific XBlock. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/edx_platform/edx_studio.rst b/docs/xblock-tutorial/edx_platform/edx_studio.rst index 4e1a24074..3a4340888 100644 --- a/docs/xblock-tutorial/edx_platform/edx_studio.rst +++ b/docs/xblock-tutorial/edx_platform/edx_studio.rst @@ -37,6 +37,3 @@ Studio requires XBlocks to have the following properties. * A class property named ``non_editable_metadata_fields``. This variable contains a list of the XBlock fields that should not be displayed in the Studio editor. - - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/front_matter/index.rst b/docs/xblock-tutorial/front_matter/index.rst index 0c97f20a7..4a34be27e 100644 --- a/docs/xblock-tutorial/front_matter/index.rst +++ b/docs/xblock-tutorial/front_matter/index.rst @@ -1,8 +1,8 @@ .. _Front Matter: -############################# +################### General Information -############################# +################### .. toctree:: :maxdepth: 2 diff --git a/docs/xblock-tutorial/front_matter/read_me.rst b/docs/xblock-tutorial/front_matter/read_me.rst index cc6b93864..ce1329b36 100644 --- a/docs/xblock-tutorial/front_matter/read_me.rst +++ b/docs/xblock-tutorial/front_matter/read_me.rst @@ -11,6 +11,3 @@ https://github.com/openedx/edx-documentation/tree/master/en_us/xblock-tutorial/s The edX documentation team welcomes contributions from Open edX community members. You can find guidelines for how to `contribute to edX Documentation`_ in the GitHub edx/edx-documentation repository. - -.. include:: ../../../links/links.rst - diff --git a/docs/xblock-tutorial/getting_started/create_first_xblock.rst b/docs/xblock-tutorial/getting_started/create_first_xblock.rst index 35c24e369..78fcefc38 100644 --- a/docs/xblock-tutorial/getting_started/create_first_xblock.rst +++ b/docs/xblock-tutorial/getting_started/create_first_xblock.rst @@ -29,5 +29,3 @@ the next sections, you will learn :ref:`how to use the XBlock SDK `, about the :ref:`anatomy of an XBlock `, and :ref:`how to customize your new XBlock `. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/getting_started/prereqs.rst b/docs/xblock-tutorial/getting_started/prereqs.rst index 6930d4802..be92fb959 100644 --- a/docs/xblock-tutorial/getting_started/prereqs.rst +++ b/docs/xblock-tutorial/getting_started/prereqs.rst @@ -53,5 +53,3 @@ instructions. For information on creating the virtual environment for your XBlock, see :ref:`Create and Activate the Virtual Environment`. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/getting_started/setup_sdk.rst b/docs/xblock-tutorial/getting_started/setup_sdk.rst index b03387dd6..cdaba8e96 100644 --- a/docs/xblock-tutorial/getting_started/setup_sdk.rst +++ b/docs/xblock-tutorial/getting_started/setup_sdk.rst @@ -69,5 +69,3 @@ Then create the virtual environment in your ``xblock_development`` directory. .. include:: ../reusable/clone_sdk.rst When the requirements are installed, you are in the ``xblock_development`` directory, which contains the ``venv`` and ``xblock-sdk`` subdirectories. You can now :ref:`create your first XBlock `. - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/overview/examples.rst b/docs/xblock-tutorial/overview/examples.rst index cb6447eb7..34acc9024 100644 --- a/docs/xblock-tutorial/overview/examples.rst +++ b/docs/xblock-tutorial/overview/examples.rst @@ -82,5 +82,3 @@ You can explore the other example XBlocks in the XBlock SDK. * `Slider XBlock`_ * Several `Content XBlocks`_ * Several `Structure XBlocks`_ - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/overview/introduction.rst b/docs/xblock-tutorial/overview/introduction.rst index 13aea5606..55e1db4a9 100644 --- a/docs/xblock-tutorial/overview/introduction.rst +++ b/docs/xblock-tutorial/overview/introduction.rst @@ -91,9 +91,9 @@ you should have basic knowledge of the following technologies. * Python virtualenv * Git -=================== +================ XBlock Resources -=================== +================ This tutorial is meant to guide developers through the process of creating an XBlock, and to explain the :ref:`concepts` and @@ -102,9 +102,9 @@ XBlock, and to explain the :ref:`concepts` and EdX provides the `XBlock SDK`_ to support the creation of new XBlocks. Developers should also see the :ref:`xblockapi:EdX XBlock API Guide`. -========================================= +======================================== XBlock Independence and Interoperability -========================================= +======================================== You must design your XBlock to meet two criteria. @@ -113,6 +113,3 @@ You must design your XBlock to meet two criteria. * The XBlock must work together with other XBlocks. Course teams must be able to combine different XBlocks in flexible ways. - - -.. include:: ../../../links/links.rst diff --git a/docs/xblock-tutorial/sdk/get_started_sdk.rst b/docs/xblock-tutorial/sdk/get_started_sdk.rst index 96309e323..d281214fd 100644 --- a/docs/xblock-tutorial/sdk/get_started_sdk.rst +++ b/docs/xblock-tutorial/sdk/get_started_sdk.rst @@ -17,5 +17,3 @@ This section describes how to get started with the XBlock SDK. .. include:: ../reusable/create_db.rst .. include:: ../reusable/run_server.rst - -.. include:: ../../../links/links.rst