[PR #17520] [MERGED] Closes #16669: Include a notice when rendering docs locally #15110

Closed
opened 2025-12-30 00:20:03 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/17520
Author: @jeremystretch
Created: 9/17/2024
Status: Merged
Merged: 9/17/2024
Merged by: @jeremystretch

Base: developHead: 16669-local-docs-notice


📝 Commits (1)

  • 6511456 Closes #16669: Include a notice when rendering docs locally

📊 Changes

1 file changed (+18 additions, -0 deletions)

View changed files

docs/_theme/partials/copyright.html (+18 -0)

📄 Description

Closes: #16669

To test a local build, run:

mkdocs serve

This should display a notification message in the footer. To emulate a public build, run:

BUILD_PUBLIC=1 mkdocs serve

The notification should not be present.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/17520 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 9/17/2024 **Status:** ✅ Merged **Merged:** 9/17/2024 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `develop` ← **Head:** `16669-local-docs-notice` --- ### 📝 Commits (1) - [`6511456`](https://github.com/netbox-community/netbox/commit/6511456e192d5b7d390bdd84198b819df829771c) Closes #16669: Include a notice when rendering docs locally ### 📊 Changes **1 file changed** (+18 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `docs/_theme/partials/copyright.html` (+18 -0) </details> ### 📄 Description ### Closes: #16669 To test a local build, run: ``` mkdocs serve ``` This should display a notification message in the footer. To emulate a public build, run: ``` BUILD_PUBLIC=1 mkdocs serve ``` The notification should not be present. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-30 00:20:03 +01:00
adam closed this issue 2025-12-30 00:20:04 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#15110