diff --git a/boards/beagleboard/index.rst b/boards/beagleboard/index.rst index beb56cd177881343655724e91d1d6a12736c7867..bcd643cdd5ff07b70062b767a6079b57ce7ee37a 100644 --- a/boards/beagleboard/index.rst +++ b/boards/beagleboard/index.rst @@ -1,3 +1,5 @@ +.. _beagleboard-boards-home: + BeagleBoard (all) ################### diff --git a/boards/beaglebone/index.rst b/boards/beaglebone/index.rst index cd47c0d1e1ec7a5daad761d4004a1f45d727bd68..7e8b32ef4845b6fe55b09d86153c969a2647c971 100644 --- a/boards/beaglebone/index.rst +++ b/boards/beaglebone/index.rst @@ -1,4 +1,4 @@ -.. _beaglebone-blue-home:: +.. _beaglebone-all-home: BeagleBone (all) ################### diff --git a/boards/capes/index.rst b/boards/capes/index.rst index d2fba272cabd2f7650d8ea51e8d2eb0dbad58bc5..186313195e55b24107972e309f4515a1fb3c1ed0 100644 --- a/boards/capes/index.rst +++ b/boards/capes/index.rst @@ -1,3 +1,5 @@ +.. _capes: + Capes ##### diff --git a/boards/index.rst b/boards/index.rst index b465904763b0ef357b22943f581e5fce178e9965..519d98e15e842634334989616ca0b7e6e3abae9b 100644 --- a/boards/index.rst +++ b/boards/index.rst @@ -1,21 +1,23 @@ +.. _boards: + Boards ###### -`BeagleBone <beaglebone>`__ is a family of ARM-based, Linux-capable boards intended to be +:ref:`BeagleBone <beaglebone-all-home>` is a family of ARM-based, Linux-capable boards intended to be bare-bones, with a balance of features to enable rapid prototyping and provide a solid reference for building end products. -`PocketBeagle <pocketbeagle>`__ boards are ultra-tiny ARM-based, Linux-capable boards intended to be +:ref:`pocketbeagle-home` boards are ultra-tiny ARM-based, Linux-capable boards intended to be very low cost, with minimal features suitable for beginners and attractive to professionals looking for a more minimal starting point. -`BeagleBone and PocketBeagle Capes <capes>`__ are add-on boards for BeagleBone and PocketBeagle boards. +BeagleBone and PocketBeagle :ref:`capes` are add-on boards for BeagleBone and PocketBeagle boards. -`BeagleConnect <beagleconnect>`__ boards are ARM microcontroller-based, Zephyr-capable boards meant +:ref:`beagleconnect-home` boards are ARM microcontroller-based, Zephyr-capable boards meant to act as ultra low cost smart peripherals to their Linux-capable counterparts, with connectivity options that enable almost endless sensing and actuation expansion. -`BeagleBoard <beagleboard>`__ is a family of ARM-based, Linux-capable boards where this project +:ref:`BeagleBoard <beagleboard-boards-home>` is a family of ARM-based, Linux-capable boards where this project started. .. toctree:: diff --git a/books/index.rst b/books/index.rst index 1cf8a938c3c882893ede9788f121becfe756a4e1..4640aed024bb3d01e4e17a197c4c7c53acb6be1e 100644 --- a/books/index.rst +++ b/books/index.rst @@ -1,3 +1,5 @@ +.. _books-home: + Books ***** diff --git a/index.rst b/index.rst index 5bf6fc53764f1cd503cdacb8ce1354548d0837db..258aa959caaa8b2c9e01eda89dc7dd2477e46599 100644 --- a/index.rst +++ b/index.rst @@ -17,10 +17,10 @@ Welcome to the `BeagleBoard project documentation <https://git.beagleboard.org/d Introduction ************ -Get started by `engaging the BealgeBoard.org developer community </intro/>`__. +Get started engaging the BeagleBoard.org developer community by reading our :ref:`introduction` page. -* Read about how to: `get started and get help </intro/support>`__ -* Learn how to: `contribute to the project </intro/contribution>`__ +* Read about how to get started and get help on our :ref:`support` page. +* Learn how to contribute to the project on our :ref:`contribution` page. .. toctree:: :maxdepth: 2 @@ -42,9 +42,9 @@ design, including the `materials <https://git.beagleboard.org/explore/projects/topics/boards>`__ to modify the designs from source using appropriate design tools. -* Check out our most popular board at: `BeagleBone Black </boards/beaglebone/black>`__ -* Check out our latest board at: `BeagleBone AI-64 </boards/beaglebone/ai-64>`__ -* Find all of our on: `our boards page </boards/index>`__ +* Check out our most popular board at: :ref:`beagleboneblack-home` +* Check out our latest board at: :ref:`bbai64-home` +* Find all of our on: :ref:`boards` .. grid:: 1 1 1 2 :margin: 4 4 0 0 @@ -322,11 +322,10 @@ developers. Some developers choose to host documentation for their projects `her Books ***** -This project hosts a -`collection of open-source books written to help Beagle developers </books/index>`__. +This project hosts a collection of open-source :ref:`books-home` books written to help Beagle developers. -* Find a great introduction to BeagleBone at: `BeagleBone Cookbook </books/beaglebone-cookbook>`__ -* Learn one of the most amazing Beagle features at: `PRU Cookbook </books/pru-cookbook>`__ +* Find a great introduction to BeagleBone at: :ref:`bone-cook-book-home` +* Learn one of the most amazing Beagle features at: :ref:`pru-cookbook-home` .. toctree:: :maxdepth: 1 diff --git a/intro/contribution/index.rst b/intro/contribution/index.rst index bd4ecc99215c52822287dc2aaa54f98d682feb10..d2dd9ad50da856e1b0b358e47d6b7650a09c87ef 100644 --- a/intro/contribution/index.rst +++ b/intro/contribution/index.rst @@ -1,4 +1,4 @@ -.. _beagleboard-contributoin: +.. _contribution: Contribution ############### diff --git a/intro/index.rst b/intro/index.rst index 939be4969e719e04a05f8b2176aaceb1f0f241c6..22fbdbc77802da87f94fcaa1e63460a6700d0d50 100644 --- a/intro/index.rst +++ b/intro/index.rst @@ -1,15 +1,17 @@ +.. _introduction: + Introduction ############# Welcome to the BeagleBoard documentation project. If you are looking for help with your Beagle open-hardware development platform, you've found the right place! -Please check out our `Support Page <support>`__ to find out how to get started, resolve issues, +Please check out our :ref:`support` page` to find out how to get started, resolve issues, and engage the developer community. Don't forget that this is an open-source project! Your contributions are welcome. Learn about how to contribute to the BeagleBoard documentation project and any of the many open-source Beagle -projects on-going on our `Contribution Page <contribution>`__. +projects on-going on our :ref:`contribution` page. .. toctree:: :maxdepth: 2