Add templates for evaluation board user guides

docs/contributing/creating_new_pages.rst

@@ -12,7 +12,7 @@
 Documentation structure
 -----------------------
 
 :git-documentation:`This </>` repository hosts any type of content that is not
 version controlled with a particular source code, or in other words,
 "don't deserve their own repository".
 
@@ -20,13 +20,13 @@
 for example, there is information from
 :ref:`linux drivers`
 to
-:ref:`Evaluation boards user guides <eval user-guides>`.
+:ref:`Evaluation boards user guides <reference-designs>`.
 
 As an analogy, if this documentation were a encyclopedia, each topic would be
 a volume.
 
 To create each "volume", two
 `toctrees <https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree>`__
 replicate the structure of the context top level.
 
 For example, while in :git-documentation:`docs/index.rst#L24`
@@ -52,7 +52,7 @@
 
       */index
 
 *Glob* is used to match any document that matches the pattern and avoids simple
 but annoying merge conflicts of contributors adding pages to the same toctree
 at the same time.
 
@@ -74,7 +74,7 @@
 .. tip::
 
    Notice the usage of the ``:glob:`` options.
    It is particular useful to avoid merge conflict scenarios.
 
 
 To add to this doc, we only need to append to *docs/index.rst* as:
@@ -107,11 +107,11 @@
 --------------
 
 The documentation is highly hierarchical and contextual, that means a page
 about "Peeling Blue Bananas" should be located at
 ``fruits/banana/blue/peeling.rst``
 and **not** ``eval/tutorial-peeling_blue_bananas.rst``.
 
 The title should also be kept short, since it directly inherits the context from
 the hierarchical structure, so it's preferred:
 
 .. code:: rst
@@ -126,7 +126,7 @@
    Fruits tutorials: peeling blue bananas
    ======================================
 
 At the ``toctree``, the title shall be overwritten to reduce the title length
 on the sidebar further:
 
 .. code:: rst
@@ -181,7 +181,7 @@
 
 Even better than having to run ``make html`` at every edit, you can leverage
 :external+doctools:ref:`author-mode` to have a live-updating instance of the doc,
 you just need to save the file and the build will be triggered automatically.
 
 Adding images and other binary files
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -193,10 +193,10 @@
 manage them for you.
 
 When adding images and other binary files, if the extension matches the :git-documentation:`.gitattributes`
 file, git lfs will automatically create a symbolic link and upload to the remote with
 ``git lfs push public --all``.
 
 Please remember that repository write permission is required for pushing git lfs artifacts,
 so if you are working on a fork, push them to your fork, and a reviewer can fetch and push to public/origin
 accordingly.
 
@@ -208,7 +208,7 @@
 Importing from DokuWiki
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 To import content from dokuwiki, a script is available to help on this task:
 `DokuWiki to Sphinx (bash.sh) <https://gist.github.com/gastmaier/9d9c8281dc3c8551991a857cdb2692cc>`__.
 
 It requires you have ``pandoc`` and ``sed`` installed:
@@ -223,7 +223,7 @@
 For images, ensure to click on the image on *wiki.analog.com* to ensure you
 download the original and not the compressed image.
 
 Always prioritize vector images (*.svg*).
 
 Finally, content yet not imported, keep/use the :external+doctools:ref:`role dokuwiki`.
 And for deprecated content, add the qualifier ``+deprecated``, for example:

docs/index.rst

@@ -5,7 +5,7 @@
 
    Work-in-progress, not all content available at the
    `wiki <https://wiki.analog.com/resources/eval/user-guides/>`_
    has been imported yet.
 
 This docs provides developers using Analog Devices products with software and
 documentation, including HDL interface code, software drivers, and reference
@@ -30,13 +30,6 @@
 
    software/*/index
 
-.. toctree::
-   :caption: Evaluation Boards
-   :maxdepth: 2
-   :glob:
-
-   eval/*/index
-
 .. toctree::
    :caption: Products & Tools
    :maxdepth: 2

docs/linux/drivers/iio-transceiver/adrv9009/index.rst

@@ -3,7 +3,7 @@
 ADRV9009, ADRV9008-1, ADRV9008-2
 """"""""""""""""""""""""""""""""
 
-.. image:: /eval/user-guide/transceiver/adrv9009/adrv9009-bc.jpg
+.. image:: /solutions/reference-designs/eval-adrv9009/adrv9009-bc.jpg
    :align: right
    :width: 200px
 
@@ -17,8 +17,8 @@
 time-shared observation path receiver for use in TDD applications. The complete
 receive subsystem includes automatic and manual attenuation control, dc offset
 correction, quadrature error correction (QEC), and digital filtering, thus
 eliminating the need for these functions in the digital baseband. Several
 auxiliary functions such as ADCs, DACs, and GPIOs for PA and RF-front-end
 control are also integrated. In addition to the autonomous AGC, it also has
 flexible external gain control modes, allowing significant flexibility in
 setting system level gain dynamically.
@@ -43,7 +43,7 @@
 This is a Linux industrial I/O (:ref:`IIO <iio>`)
 subsystem driver, targeting RF Transceivers. The industrial I/O subsystem
 provides a unified framework for drivers for many different types of converters
 and sensors using a number of different physical interfaces (i2c, spi, etc). See
 :ref:`IIO <iio>` for more information.
 
 Source Code
@@ -58,11 +58,11 @@
    -  - Source
       - Mainlined?
    -  - driver
       - :git-linux:`drivers/iio/adc/adrv9009.c`
    -  - driver
       - :git-linux:`drivers/iio/adc/adrv9009_conv.c`
    -  - include
       - :git-linux:`drivers/iio/adc/adrv9009.h`
    -  - Talise API driver
       - :git-linux:`drivers/iio/adc/talise`