Documentation on ReadTheDocs is not being indexed by search engines #7039

Closed
opened 2025-12-29 19:48:12 +01:00 by adam · 0 comments
Owner

Originally created by @jeremystretch on GitHub (Sep 28, 2022).

Originally assigned to: @jeremystretch on GitHub.

Change Type

Correction

Area

Other

Proposed Changes

When the public documentation is being built by ReadTheDocs, the following meta tag is being added erroneously, which prevents indexing:

<meta name="robots" content="noindex">

This was introduced under #9994 in an attempt to disable indexing of publicly accessible NetBox instances (such as our demo instance). I could swear this was working as intended at implementation, but I may be mistaken: This issue suggests that environment variables are not accessible to mydocs.yaml due to the use of a nonstandard YAML parser.

Originally created by @jeremystretch on GitHub (Sep 28, 2022). Originally assigned to: @jeremystretch on GitHub. ### Change Type Correction ### Area Other ### Proposed Changes When [the public documentation](https://docs.netbox.dev/en/stable/) is being built by ReadTheDocs, the following meta tag is being added erroneously, which prevents indexing: ``` <meta name="robots" content="noindex"> ``` This was introduced under #9994 in an attempt to disable indexing of publicly accessible NetBox instances (such as our demo instance). I could swear this was working as intended at implementation, but I may be mistaken: [This issue](https://github.com/readthedocs/readthedocs.org/issues/8529) suggests that environment variables are not accessible to `mydocs.yaml` due to the use of a nonstandard YAML parser.
adam added the status: acceptedtype: documentation labels 2025-12-29 19:48:12 +01:00
adam closed this issue 2025-12-29 19:48:13 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#7039