WIP refactoring docs to comply more closely with Kartoza standard layout

timlinux · Dec 17, 2023 · 5ec0741 · 5ec0741
1 parent dba9525
commit 5ec0741
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 56 deletions.
diff --git a/docs/build-docs-pdf.sh b/docs/build-docs-pdf.sh
@@ -10,5 +10,5 @@
 #mkdocs build --config-file mkdocs-overview.yml > /tmp/overview-document.html
 mkdocs build --config-file mkdocs-users.yml > /tmp/users-document.html
 #mkdocs build --config-file mkdocs-administrators.yml > /tmp/administrators-document.html
-#mkdocs build --config-file mkdocs-developers.yml > /tmp/developers-document.html
+mkdocs build --config-file mkdocs-developers.yml > /tmp/developers-document.html
 #mkdocs build --config-file mkdocs-devops.yml > /tmp/devops-document.html
diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml
@@ -18,56 +18,51 @@ nav:
     - Contribute: about/contribute.md
     - License: about/license.md
     - Credits: about/credits.md
-#  - User:
-#    - user/index.md
-#    - Quickstart:
-#      - Installation: user/quickstart/install.md
-#      - Initial Configuration: user/quickstart/configure.md
-#      - Using the Workbench: user/quickstart/using.md
-#    - Guide:
-#      - user/guide/index.md
-#      - 1 Points on a Line: user/guide/tutorial1.md
-#      - 2 Dynamic Markers: user/guide/tutorial2.md
-#      - 3 Flying Points: user/guide/tutorial3.md
-#      - 4 Spinning Globe: user/guide/tutorial4.md
-#      - 5 Planar Map: user/guide/tutorial5.md
-#    - Manual:
-#      - user/manual/index.md
-#      - Preparing your project: user/manual/project_preparation.md
-#      - The workbench user interface: user/manual/workbench_ui.md
-#      - Expression Variables: library/variables.md
-#      - Expression Examples: library/snippets.md
-#      - Under the hood: user/manual/under_the_hood.md
-#    - FAQ: user/manual/faq.md
-# - Administrators:
-#   - administrator/index.md
-#   - Guide:
-#   - Manual:
-# - Developer:
-#   - developer/index.md
-#   - Guide:
-#     - developer/guide/index.md
-#     - Architecture: developer/guide/architecture.md
-#     - Prerequisites: developer/guide/prerequisites.md
-#     - Design: developer/guide/design.md
-#     - IDE Setup: developer/guide/ide-setup.md
-#     - Cloning: developer/guide/cloning.md
-#     - Configuration: developer/guide/configuration.md
-#     - Building: developer/guide/building.md
-#     - Workflows: developer/guide/workflows.md
-#     - Testing: developer/guide/testing.md
-#     - Documentation: developer/guide/docs.md
-#   - Manual:
-#     - developer/manual/index.md
-#   - API:
-#     - developer/api/index.md
-#   - Reference: developer/api/manual/index.md
-#   - Guide: developer/api/guide/index.md
-#   - Documentation Writing:
-#     - developer/documentation/index.md
-#   - Overview: developer/documentation/overview.md
-#   - Context Help: developer/documentation/context-help.md
-#   - License: about/license.md
+  - User:
+    - user/index.md
+    - Quickstart:
+      - Installation: user/quickstart/install.md
+      - Initial Configuration: user/quickstart/configure.md
+      - Using the Workbench: user/quickstart/using.md
+    - Guide:
+      - user/guide/index.md
+      - 1 Points on a Line: user/guide/tutorial1.md
+      - 2 Dynamic Markers: user/guide/tutorial2.md
+      - 3 Flying Points: user/guide/tutorial3.md
+      - 4 Spinning Globe: user/guide/tutorial4.md
+      - 5 Planar Map: user/guide/tutorial5.md
+    - Manual:
+      - user/manual/index.md
+      - Preparing your project: user/manual/project_preparation.md
+      - The workbench user interface: user/manual/workbench_ui.md
+      - Expression Variables: library/variables.md
+      - Expression Examples: library/snippets.md
+      - Under the hood: user/manual/under_the_hood.md
+    - FAQ: user/manual/faq.md
+  - Developer:
+    - developer/index.md
+    - Guide:
+      - developer/guide/index.md
+      - Architecture: developer/guide/architecture.md
+      - Prerequisites: developer/guide/prerequisites.md
+      - Design: developer/guide/design.md
+      - IDE Setup: developer/guide/ide-setup.md
+      - Cloning: developer/guide/cloning.md
+      - Configuration: developer/guide/configuration.md
+      - Building: developer/guide/building.md
+      - Workflows: developer/guide/workflows.md
+      - Testing: developer/guide/testing.md
+      - Documentation: developer/guide/docs.md
+    - Manual:
+      - developer/manual/index.md
+    - API:
+      - developer/api/index.md
+    - Reference: developer/api/manual/index.md
+    - Guide: developer/api/guide/index.md
+    - Documentation Writing:
+      - developer/documentation/index.md
+    - Overview: developer/documentation/overview.md
+    - Context Help: developer/documentation/context-help.md
 # - DevOps:
 #   - devops/index.md
 #   - Guide: devops/guide/index.md

diff --git a/docs/mkdocs-pdf-developers.yml b/docs/mkdocs-pdf-developers.yml
@@ -1,5 +1,5 @@
       output_path: ../pdfs/4-QGISAnimationWorkbench-DeveloperGuide.pdf
-       cover_subtitle: 'Part 4 - QGIS Animation Workbench Developer Guide.'
+      cover_subtitle: 'Part 4 - QGIS Animation Workbench Developer Guide.'
       exclude_pages:
           - 'about/'
           - 'administrator/'

diff --git a/docs/src/user/manual/faq.md b/docs/src/user/manual/faq.md
@@ -2,11 +2,11 @@
 
 #### Can I add any image to the intro or outro?
 
-- As long as you can provide the proper attribution for an image you can use it in your project.
+As long as you can provide the proper attribution for an image you can use it in your project.
 
 #### I have an older, less powerful, computer, will it handle running this workbench?
 
-- If you open the standard QGIS settings dialog and select the Animation Workbench options
+If you open the standard QGIS settings dialog and select the Animation Workbench options
 you can follow the advice with regards to lowering the number of threads allowed during
 rendering to help you computer cope. Rendering shorter movies or GIFs (i.e. fewer frames)
 will also help. Below is an example of running a job with 9000 frames at 60fps and 999
@@ -28,7 +28,11 @@ And here is the resulting video:
 
 #### I get an error when rendering because of my intro / outro images
 
-Currently your filenames should not contain spaces or special characters (e.g.(, ), [, ], {, }, <, >, /, \, :, *, ?, |, ", &, etc.).
+Currently your filenames should not contain spaces or special characters 
+
+```
+.(, ), [, ], {, }, <, >, /, \, :, *, ?, |, ", &, etc.).
+```
 
 #### Can I use a movie as the intro / outro media?
 
@@ -40,4 +44,4 @@ This is a fun / hobby project, currently we want other contributors who also wan
 have a fun experience with building this plugin and contribute in-kind efforts to the
 project. Both [Kartoza](https://kartoza.com) and [North-Road](https://north-road.com/)
 offer commercial development services but not for this plugin which is a intended to
-provide an experimental, no-pressire space for us to work on something fun for QGIS.
+provide an experimental, no-pressure space for us to work on something fun for QGIS.