Removed "cilexer" dependency from sphinx and updated manual accordingly. Fixed incorrectly rendered userguide pages. [ci skip]

jreklund · jreklund · commit 3eea893def8d · 2020-03-07T23:53:31.000+01:00
diff --git a/contributing/documentation.rst b/contributing/documentation.rst
@@ -36,17 +36,10 @@ Tools Required
 **************
 
 To see the rendered HTML, ePub, PDF, etc., you will need to install Sphinx
-along with the PHP domain extension for Sphinx.  The underlying requirement
-is to have Python installed.  Lastly, you will install the CI Lexer for
-Pygments, so that code blocks can be properly highlighted.
+along with the PHP domain extension for Sphinx. The underlying requirement
+is to have Python installed.
 
-.. code-block:: bash
-
-	easy_install "sphinx==1.4.5"
-	easy_install sphinxcontrib-phpdomain
-
-Then follow the directions in the README file in the :samp:`cilexer` folder
-inside the documentation repository to install the CI Lexer.
+You can read more about installing all tools in /user_guide_src/README.rst
 
 *****************************************
 Page and Section Headings and Subheadings
diff --git a/user_guide_src/README.rst b/user_guide_src/README.rst
@@ -13,19 +13,19 @@ output it to various formats. Pages are written in human-readable
 Prerequisites
 =============
 
-Sphinx requires Python, which is already installed if you are running OS X.
+Sphinx requires Python 2, which may already be installed if you are running OS X or Linux.
 You can confirm in a Terminal window by executing the ``python`` command
 without any parameters. It should load up and tell you which version you have
-installed. If you're not on 2.7+, go ahead and install 2.7.2 from
-http://python.org/download/releases/2.7.2/
+installed. If you're not on 2.7+, go ahead and install 2.7+ from
+`Python.org <https://www.python.org/downloads/>`_
 
 Installation
 ============
 
-1. Install `easy_install <http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install>`_
-2. ``easy_install "sphinx==1.8.5"``
-3. ``easy_install sphinxcontrib-phpdomain``
-4. Install the CI Lexer which allows PHP, HTML, CSS, and JavaScript syntax highlighting in code examples (see *cilexer/README*)
+1. Install `pip <https://packaging.python.org/guides/installing-using-linux-tools/>`_ (package manager).
+2. ``pip install "sphinx==1.8.5"``
+3. ``pip install "sphinxcontrib-phpdomain>=0.7.0"``
+4. Reboot your operating system
 5. ``cd user_guide_src``
 6. ``make html``
 
@@ -59,5 +59,5 @@ simply delete the *build* folder's contents and rebuild.
 Style Guideline
 ***************
 
-Please refer to source/contributing/documentation.rst for general guidelines for
+Please refer to /contributing/documentation.rst for general guidelines for
 using Sphinx to document CodeIgniter.
diff --git a/user_guide_src/cilexer/README b/user_guide_src/cilexer/README
diff --git a/user_guide_src/cilexer/cilexer/__init__.py b/user_guide_src/cilexer/cilexer/__init__.py
diff --git a/user_guide_src/cilexer/cilexer/cilexer.py b/user_guide_src/cilexer/cilexer/cilexer.py
diff --git a/user_guide_src/cilexer/setup.py b/user_guide_src/cilexer/setup.py
diff --git a/user_guide_src/source/changelogs/index.rst b/user_guide_src/source/changelogs/index.rst
@@ -16,6 +16,7 @@ Release Date: Not Released
         :titlesonly:
 
         next
+        v4.0.0
         v4.0.0-rc.4
         v4.0.0-rc.3
         v4.0.0-rc.2
diff --git a/user_guide_src/source/changelogs/next.rst b/user_guide_src/source/changelogs/next.rst
@@ -3,12 +3,11 @@ Version |version|
 
 Release Date: Not released
 
-**Next alpha release of CodeIgniter4**
+**Next release of CodeIgniter4**
 
 
 The list of changed files follows, with PR numbers shown.
 
 
 PRs merged:
 -----------
-
diff --git a/user_guide_src/source/conf.py b/user_guide_src/source/conf.py
@@ -53,7 +53,7 @@
 # The short X.Y version.
 version = '4.0-dev'
 # The full version, including alpha/beta/rc tags.
-release = '4.0.0-rc.4'
+release = '4.0.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -85,7 +85,8 @@
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'trac'
-highlight_language = 'ci'
+highlight_language = 'html+php'
+highlight_options = {'startinline':True}
 
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
diff --git a/user_guide_src/source/general/ajax.rst b/user_guide_src/source/general/ajax.rst
@@ -11,6 +11,8 @@ Here's how to force the ``X-Requested-With`` header to be sent in the Fetch API
 Fetch API
 =========
 
+.. code-block:: javascript
+
     fetch(url, {
         method: "get",
         headers: {
@@ -29,23 +31,29 @@ jQuery
 
 For libraries like jQuery for example, it is not necessary to make explicit the sending of this header, because according to the official documentation <https://api.jquery.com/jquery.ajax/> it is a standard header for all requests ``$.ajax()``. But if you still want to force the shipment to not take risks, just do it as follows:
 
+.. code-block:: javascript
+
     $.ajax({
         url: "your url",
 
         headers: {'X-Requested-With': 'XMLHttpRequest'}
 
-    });  
+    });
 
 
 VueJS
 =====
 
 In VueJS you just need to add the following code to the ``created`` function, as long as you are using Axios for this type of request.
 
+.. code-block:: javascript
+
     axios.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest';
 
 
 React
 =====
 
+.. code-block:: javascript
+
     axios.get("your url", {headers: {'Content-Type': 'application/json'}})
diff --git a/user_guide_src/source/general/managing_apps.rst b/user_guide_src/source/general/managing_apps.rst
@@ -11,27 +11,27 @@ rename or relocate your application directory.
 Renaming or Relocating the Application Directory
 ================================================
 
-If you would like to rename your application directory or even move 
+If you would like to rename your application directory or even move
 it to a different location on your server, other than your project root, open
 your main **app/Config/Paths.php** and set a *full server path* in the
 ``$appDirectory`` variable (at about line 38)::
 
-	public $appDirectory = '/path/to/your/application';
+    public $appDirectory = '/path/to/your/application';
 
 You will need to modify two additional files in your project root, so that
-they can find the ``Paths`` configuration file: 
+they can find the ``Paths`` configuration file:
 
 - ``/spark`` runs command line apps; the path is specified on or about line 36::
 
-        require 'app/Config/Paths.php';
-        // ^^^ Change this if you move your application folder
+    require 'app/Config/Paths.php';
+    // ^^^ Change this if you move your application folder
 
 
 - ``/public/index.php`` is the front controller for your webapp; the config
-    path is specified on or about line 16::
+  path is specified on or about line 16::
 
-        $pathsPath = FCPATH . '../app/Config/Paths.php';
-        // ^^^ Change this if you move your application folder
+    $pathsPath = FCPATH . '../app/Config/Paths.php';
+    // ^^^ Change this if you move your application folder
 
 
 Running Multiple Applications with one CodeIgniter Installation
@@ -44,9 +44,9 @@ inside your application directory into their own (sub)-directory.
 For example, let's say you want to create two applications, named "foo"
 and "bar". You could structure your application project directories like this::
 
-	foo/app, public, tests and writable
-        bar/app/, public, tests and writable
-        codeigniter/system and docs
+    foo/app, public, tests and writable
+    bar/app/, public, tests and writable
+    codeigniter/system and docs
 
 This would have two apps, "foo" and "bar", both having standard application directories
 and a ``public`` folder, and sharing a common codeigniter framework.
diff --git a/user_guide_src/source/requirements.txt b/user_guide_src/source/requirements.txt
@@ -0,0 +1,2 @@
+sphinx==1.8.5
+sphinxcontrib-phpdomain>=0.7.0
