doc: restructure and create index pages

Move all lead pages to be index pages and create redirect rules from the old pointers. Signed-off-by: Anas Nashif <[email protected]>
jmyllyla · Feb 5, 2019 · 2b9458c · 2b9458c
1 parent 58632f8
commit 2b9458c
Show file tree

Hide file tree

Showing 13 changed files with 54 additions and 40 deletions.
diff --git a/README.rst b/README.rst
@@ -121,13 +121,13 @@ support systems:
 
 .. _Slack Invite: https://tinyurl.com/yarkuemx
 .. _Slack: https://zephyrproject.slack.com
-.. _supported boards: http://docs.zephyrproject.org/latest/boards/boards.html
+.. _supported boards: http://docs.zephyrproject.org/latest/boards
 .. _Zephyr Documentation: http://docs.zephyrproject.org
-.. _Zephyr Introduction: http://docs.zephyrproject.org/latest/introduction/introducing_zephyr.html
-.. _Getting Started Guide: http://docs.zephyrproject.org/latest/getting_started/getting_started.html
-.. _Contribution Guide: http://docs.zephyrproject.org/latest/contribute/index.html
+.. _Zephyr Introduction: http://docs.zephyrproject.org/latest/introduction
+.. _Getting Started Guide: http://docs.zephyrproject.org/latest/getting_started
+.. _Contribution Guide: http://docs.zephyrproject.org/latest/contribute
 .. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
 .. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel
 .. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups
-.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/latest/samples/samples.html
-.. _Security Overview: http://docs.zephyrproject.org/latest/security/security-overview.html
+.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/latest/samples
+.. _Security Overview: http://docs.zephyrproject.org/latest/security
diff --git a/boards/boards.rst → boards/index.rst b/boards/boards.rst → boards/index.rst
diff --git a/cmake/host-tools.cmake b/cmake/host-tools.cmake
@@ -33,7 +33,7 @@ if(${CMAKE_MATCH_1} VERSION_LESS ${MIN_DTC_VERSION})
   assert(0 "The detected dtc version is unsupported.                                 \n\
     The version was found to be ${CMAKE_MATCH_1}                                   \n\
     But the minimum supported version is ${MIN_DTC_VERSION}                        \n\
-    See https://docs.zephyrproject.org/latest/getting_started/getting_started.html \n\
+    See https://docs.zephyrproject.org/latest/getting_started/                     \n\
     for how to use the SDK's dtc alongside a custom toolchain."
   )
 endif()

diff --git a/doc/application/application.rst → doc/application/index.rst b/doc/application/application.rst → doc/application/index.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -288,7 +288,21 @@
 #
 # list of tuples (old_url, new_url) for pages to redirect
 # (URLs should be relative to document root, only)
-html_redirect_pages = [('contribute/contribute_guidelines', 'contribute/index'),]
+html_redirect_pages = [
+        ('contribute/contribute_guidelines', 'contribute/index'),
+        ('application/application', 'application/index.rst'),
+        ('security/security', 'security/index'),
+        ('boards/boards', 'boards/index'),
+        ('samples/samples', 'samples/index'),
+        ('releases/release-notes', 'releases/index'),
+        ('getting_started/getting_starting', 'getting_started/index'),
+        ('introduction/introducing_zephyr', 'introduction/index'),
+        ('api/index', 'reference/index'),
+        ('api/api', 'reference/index'),
+        ('subsystems/subsystems', 'reference/index'),
+        ('kernel/kernel', 'reference/kernel/index'),
+
+        ]
 
 # -- Options for LaTeX output ---------------------------------------------
 

diff --git a/doc/getting_started/getting_started.rst → doc/getting_started/index.rst b/doc/getting_started/getting_started.rst → doc/getting_started/index.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -34,59 +34,59 @@ licensing, as described in :ref:`Zephyr_Licensing`.
 
    <ul class="grid">
        <li class="grid-item">
-	   <a href="introduction/introducing_zephyr.html">
+	   <a href="introduction/index.html">
 	       <img alt="" src="_static/images/kite.png"/>
 	       <h2>Introduction</h2>
 	   </a>
 	   <p>Introducing the Zephyr Project: the overview, architecture, features and licensing</p>
        </li>
        <li class="grid-item">
-	   <a href="getting_started/getting_started.html">
+	   <a href="getting_started/index.html">
 	       <img alt="" src=""/>
 	       <h2>Getting Started Guide</h2>
 	   </a>
 	   <p>Follow this guide to set up a Zephyr development environment on your
 	       system, and then build and run a sample application.</p>
        </li>
        <li class="grid-item">
-	   <a href="contribute/">
+	   <a href="contribute/index.html">
 	       <img alt="" src=""/>
 	       <h2>Contribution Guidelines</h2>
 	   </a>
 	   <p>As an open-source project, we welcome and encourage the community
            to submit patches directly to the project.</p>
        </li>
        <li class="grid-item">
-	   <a href="samples/samples.html">
+	   <a href="samples/index.html">
 	       <img alt="" src=""/>
 	       <h2>Samples and Demos</h2>
 	   </a>
 	   <p>A list of samples and demos that can run on a variety of boards supported
 	       by Zephyr</p>
        </li>
        <li class="grid-item">
-	   <a href="reference/">
+	   <a href="reference/index.html">
 	       <img alt="" src=""/>
 	       <h2>API Reference</h2>
 	   </a>
 	   <p>API Documentation and Reference</p>
        </li>
        <li class="grid-item">
-	   <a href="security/security.html">
+	   <a href="security/index.html">
 	       <img alt="" src=""/>
 	       <h2>Security</h2>
 	   </a>
 	   <p>Requirements, processes, and developer guidelines for ensuring security is addressed within the Zephyr project.</p>
        </li>
        <li class="grid-item">
-	   <a href="boards/boards.html">
+	   <a href="boards/index.html">
 	       <img alt="" src=""/>
 	       <h2>Supported Boards</h2>
 	   </a>
 	   <p>List if supported boards and platforms.</p>
        </li>
        <li class="grid-item">
-	   <a href="guides/">
+	   <a href="guides/index.html">
 	       <img alt="" src=""/>
 	       <h2>User and Developer Guides</h2>
 	   </a>
@@ -102,17 +102,17 @@ licensing, as described in :ref:`Zephyr_Licensing`.
 .. toctree::
    :maxdepth: 1
 
-   introduction/introducing_zephyr.rst
-   getting_started/getting_started.rst
+   introduction/index.rst
+   getting_started/index.rst
    contribute/index.rst
    development_process/index.rst
-   application/application.rst
+   application/index.rst
    reference/index.rst
    guides/index.rst
-   security/security.rst
-   samples/samples.rst
-   boards/boards.rst
-   releases/release-notes.rst
+   security/index.rst
+   samples/index.rst
+   boards/index.rst
+   releases/index.rst
 
 .. only:: html
 

diff --git a/doc/introduction/introducing_zephyr.rst → doc/introduction/index.rst b/doc/introduction/introducing_zephyr.rst → doc/introduction/index.rst
diff --git a/doc/releases/release-notes.rst → doc/releases/index.rst b/doc/releases/release-notes.rst → doc/releases/index.rst
diff --git a/doc/security/security.rst → doc/security/index.rst b/doc/security/security.rst → doc/security/index.rst
@@ -1,4 +1,4 @@
-.. _zephyr-security-docs:
+.. _security_section:
 
 Security
 ########

diff --git a/samples/classic.rst b/samples/classic.rst
@@ -0,0 +1,15 @@
+.. _classic_samples:
+
+Classic Samples
+###############
+
+The following are samples that can be run on any of the supported
+platforms:
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   hello_world/*
+   synchronization/*
+   philosophers/*
diff --git a/samples/samples.rst → samples/index.rst b/samples/samples.rst → samples/index.rst
@@ -8,7 +8,7 @@ Samples and Demos
    :maxdepth: 2
    :glob:
 
-   kernel
+   classic
    basic/*
    userspace/*
    subsys/subsys.rst

diff --git a/samples/kernel.rst b/samples/kernel.rst
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,7 @@ Samples and Demos @@
        :maxdepth: 2
        :glob:
-       kernel
+       classic
        basic/*
        userspace/*
        subsys/subsys.rst
@@ Expand Down @@