How to make frontend and backend website changes to pigweed.dev, Pigweed’s main documentationw website, and how to change the functionality of Sphinx, the website generator that powers pigweed.dev.

Create redirects#

pigweed.dev supports client-side HTML redirects. The redirects are powered by sphinx-reredirects.

To create a redirect:

  1. Open //docs/conf.py.

  1. Add your redirect to the redirects dict. See the Usage section from the sphinx-reredirects docs.

    • The redirect should be relative to the source path (i.e. the path that needs to get redirected).

    • The target path (i.e. the destination path that the source path should redirect to) should include the full HTML filename to ensure that the redirects also work during local development. In other words, prefer ./example/docs.html over ./example/ because the latter assumes the existence of a server that redirects ./example/ to ./example/docs.html.

For each URL that should be redirected, sphinx-reredirects auto-generates HTML like this:

    <meta http-equiv="refresh" content="0; url=pw_sys_io_rp2040/">


Server-side redirects are the most robust solution, but client-side redirects are good enough for our needs:

  • Client-side redirects are supported in all browsers and should work therefore work for all real pigweed.dev readers.

  • Client-side redirects were much easier and faster to implement.

  • Client-side redirects can be stored alongside the rest of the pigweed.dev source code.

  • Google Search interprets the kind of client side redirects that we use as permanent redirects, which is the behavior we want. See meta refresh and its HTTP equivalent. The type of client-side redirect we used is called a “instant meta refresh redirect” in that guide.

Auto-generated source code and issues URLS#

In the site nav there’s a Source code and Issues URL for each module. These links are auto-generated. The auto-generation logic lives in //pw_docgen/py/pw_docgen/sphinx/module_metadata.py.

Copy-to-clipboard feature on code blocks#

The copy-to-clipboard feature on code blocks is powered by sphinx-copybutton.

sphinx-copybutton recognizes $ as an input prompt and automatically removes it.

There is a workflow for manually removing the copy-to-clipboard button for a particular code block but it has not been implemented yet. See Remove copybuttons using a CSS selector.