linguini1 opened a new pull request, #16275:
URL: https://github.com/apache/nuttx/pull/16275

   ## Summary
   
   Introduces `sphinx-tags` to the documentation system, allowing individual 
pages to be tagged for better searching. The examples in this commit introduce 
the `chip:*` tag for indicating the chip a board uses, as well as the 
`experimental` tag for indicating experimental boards and features. Other tags 
indicate supported peripherals for boards, such as `wifi` and `ethernet`.
   
   ## Impact
   
   This should begin to make it easier to search the NuttX documentation. Users 
can more easily filter by peripherals/attributes of features and boards instead 
of relying on finding everything in the directory structure.
   
   There is now a new page at the bottom of the sidebar that lists all of the 
tags in the Documentation. Some pages are added in this PR as an example to 
show how tags can be used; they appear as badges at the top of the page. Tags 
can also be searched in the search bar.
   
   ## Testing
   
   To test, I performed a local documentation build (both manually and with 
`sphinx-autobuild`) and checked that the documentation built properly and that 
it looked correct in the browser. I also tried navigating and searching by tags 
to make sure the new features work.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to