[Bf-docboard-svn] bf-manual: [8152] trunk/blender_docs/manual/about: Cleanup: Combine contributing building per platform docs to one

Aaron Carlisle noreply at blender.org
Tue Jun 22 02:43:29 CEST 2021 

Revision: 8152
          https://developer.blender.org/rBM8152
Author:   Blendify
Date:     2021-06-22 02:43:28 +0200 (Tue, 22 Jun 2021)
Log Message:
-----------
Cleanup: Combine contributing building per platform docs to one

The building process is now the same accross each platform

Modified Paths:
--------------
    trunk/blender_docs/manual/about/contribute/editing.rst
    trunk/blender_docs/manual/about/contribute/guides/maintenance_guide.rst
    trunk/blender_docs/manual/about/contribute/index.rst
    trunk/blender_docs/manual/about/contribute/install/linux.rst
    trunk/blender_docs/manual/about/contribute/install/macos.rst
    trunk/blender_docs/manual/about/contribute/install/windows.rst
    trunk/blender_docs/manual/about/contribute/patch_commit.rst
    trunk/blender_docs/manual/about/contribute/release_cycle.rst
    trunk/blender_docs/manual/about/contribute/translations/add_language.rst
    trunk/blender_docs/manual/about/contribute/translations/contribute.rst
    trunk/blender_docs/manual/about/index.rst

Added Paths:
-----------
    trunk/blender_docs/manual/about/contribute/build.rst

Removed Paths:
-------------
    trunk/blender_docs/manual/about/contribute/build/

Added: trunk/blender_docs/manual/about/contribute/build.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/build.rst	                        (rev 0)
+++ trunk/blender_docs/manual/about/contribute/build.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -0,0 +1,31 @@
+.. highlight:: console
+
+*******************
+Building the Manual
+*******************
+
+Converting the RST-files into pretty HTML pages is simple.
+
+Open a terminal or Command Prompt in the ``~/blender_docs`` directory and simply run::
+
+   make
+
+.. tip::
+
+   On MS-Windows you can simply open the :file:`make.bat` file to easily
+   run the command without having to open the Command Prompt and typing commands.
+
+This is the command you should use when building the docs,
+however, other commands are avaible by typing ``make help``.
+This command will convert the RST-files into HTML pages
+and automaticlly open your default web browser to view the result.
+The command will continue to run and watch for changes made to the RST-files
+and refresh the HTML pages as necessary.
+
+.. note::
+
+   The converted pages can also be viewed manually by browsing the build directory: ``~/blender_docs/build/html``.
+   For example to open the home page, open :file:`build/html/index.html` to read the manual.
+
+The building process may take several minutes the first time (or after any major changes),
+but for subsequent changes it should only take a few seconds.


Property changes on: trunk/blender_docs/manual/about/contribute/build.rst
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/blender_docs/manual/about/contribute/editing.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/editing.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/editing.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -1,3 +1,4 @@
+.. highlight:: console
 
 ******************
 Editing the Manual
@@ -15,10 +16,8 @@
 Update
 ======
 
-Firstly, make sure that your local copy of the manual is up to date with the online repository using:
+Firstly, make sure that your local copy of the manual is up to date with the online repository using::
 
-.. code-block:: sh
-
    svn update
 
 
@@ -75,7 +74,7 @@
 Preview
 =======
 
-To view your changes, build the manual :doc:`as instructed </about/contribute/build/index>`.
+To view your changes, build the manual :doc:`as instructed </about/contribute/build>`.
 Keep in mind that you can also build only the chapter you just edited to view it quickly.
 Open the generated ``.html`` files inside the ``build/html`` folder using your web browser,
 or refresh the page if you have it open already.

Modified: trunk/blender_docs/manual/about/contribute/guides/maintenance_guide.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/guides/maintenance_guide.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/guides/maintenance_guide.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -1,4 +1,4 @@
-.. highlight:: sh
+.. highlight:: console
 
 ***********
 Maintenance

Modified: trunk/blender_docs/manual/about/contribute/index.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/index.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/index.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -23,7 +23,7 @@
    :maxdepth: 1
 
    install/index.rst
-   build/index.rst
+   build.rst
    editing.rst
    patch_commit.rst
    release_cycle.rst

Modified: trunk/blender_docs/manual/about/contribute/install/linux.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/install/linux.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/install/linux.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -1,4 +1,4 @@
-.. highlight:: sh
+.. highlight:: console
 
 *********************
 Installation on Linux
@@ -18,17 +18,14 @@
 
 For the appropriate system, run the command in a terminal:
 
-Debian/Ubuntu
-   .. code-block:: sh
+Debian/Ubuntu::
 
       sudo apt-get install python3 python3-pip subversion
 
-Redhat/Fedora
-   .. code-block:: sh
+Redhat/Fedora::
 
       sudo yum install python python-pip
-Arch Linux
-   .. code-block:: sh
+Arch Linux::
 
       sudo pacman -S python python-pip subversion
 
@@ -62,8 +59,3 @@
    Every now and then you may want to make sure your dependencies are up to date using::
 
       sudo pip3 install -r requirements.txt --upgrade --upgrade-strategy eager
-
-
-------------------------
-
-Continue with the next step: :doc:`Building </about/contribute/build/linux>`.

Modified: trunk/blender_docs/manual/about/contribute/install/macos.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/install/macos.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/install/macos.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -1,4 +1,4 @@
-.. highlight:: sh
+.. highlight:: console
 
 *********************
 Installation on macOS
@@ -55,8 +55,3 @@
    Every now and then you may want to make sure your dependencies are up to date using::
 
       sudo pip install -r requirements.txt --upgrade --upgrade-strategy eager
-
-
-------------------------
-
-Continue with the next step: :doc:`Building </about/contribute/build/macos>`.

Modified: trunk/blender_docs/manual/about/contribute/install/windows.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/install/windows.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/install/windows.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -1,4 +1,4 @@
-.. highlight:: sh
+.. highlight:: console
 
 ***********************
 Installation on Windows
@@ -70,8 +70,3 @@
    Every now and then you may want to make sure your dependencies are up to date using::
 
       pip install -r requirements.txt --upgrade --upgrade-strategy eager
-
-
-------------------------
-
-Continue with the next step: :doc:`Building </about/contribute/build/windows>`.

Modified: trunk/blender_docs/manual/about/contribute/patch_commit.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/patch_commit.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/patch_commit.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -1,4 +1,4 @@
-.. highlight:: sh
+.. highlight:: console
 
 **************
 Patch & Commit

Modified: trunk/blender_docs/manual/about/contribute/release_cycle.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/release_cycle.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/release_cycle.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -1,3 +1,4 @@
+.. highlight:: console
 
 *************
 Release Cycle
@@ -23,8 +24,6 @@
 giving 2 months to add documentation for new features of the next release, and another month to make improvements.
 
 
-.. highlight:: sh
-
 Switching Branches
 ------------------
 

Modified: trunk/blender_docs/manual/about/contribute/translations/add_language.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/translations/add_language.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/translations/add_language.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -13,7 +13,7 @@
 you wish to create a set of new files for the desired language, say 'fr' (French),
 then you must first use the environment you have created,
 as guided in :ref:`Getting Started <about-getting-started>`,
-in particular :doc:`/about/contribute/install/index` and :doc:`/about/contribute/build/index` sections.
+in particular :doc:`/about/contribute/install/index` and :doc:`/about/contribute/build` sections.
 
 This will give you a foundation environment for:
 

Modified: trunk/blender_docs/manual/about/contribute/translations/contribute.rst
===================================================================
--- trunk/blender_docs/manual/about/contribute/translations/contribute.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/contribute/translations/contribute.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -1,4 +1,4 @@
-.. highlight:: sh
+.. highlight:: console
 
 **********
 Contribute

Modified: trunk/blender_docs/manual/about/index.rst
===================================================================
--- trunk/blender_docs/manual/about/index.rst	2021-06-22 00:06:44 UTC (rev 8151)
+++ trunk/blender_docs/manual/about/index.rst	2021-06-22 00:43:28 UTC (rev 8152)
@@ -25,7 +25,7 @@
    :maxdepth: 1
 
    contribute/install/index.rst
-   contribute/build/index.rst
+   contribute/build.rst
    contribute/editing.rst
    contribute/patch_commit.rst
    contribute/release_cycle.rst

More information about the Bf-docboard-svn mailing list