starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Move documentation to mkdocs-material #4593

New Issue
Closed
opened 2025-12-29 18:38:03 +01:00 by adam · 2 comments
adam commented 2025-12-29 18:38:03 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Feb 25, 2021).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

Switch the static documentation from the native ReadTheDocs theme to Material for MkDocs.

Justification

Provides a cleaner look overall, and allows us to use dynamic tabs e.g. for showing Ubuntu va CentOS commands.

Originally created by @jeremystretch on GitHub (Feb 25, 2021). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Switch the static documentation from the native ReadTheDocs theme to [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). ### Justification Provides a cleaner look overall, and allows us to use dynamic tabs e.g. for showing Ubuntu va CentOS commands.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 18:38:03 +01:00
adam closed this issue 2025-12-29 18:38:03 +01:00
adam commented 2025-12-29 18:38:04 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 25, 2021):

I've made the initial switch here: https://netbox.readthedocs.io/en/feature/

It likely still needs a bit of polish but looks good.

@jeremystretch commented on GitHub (Feb 25, 2021): I've made the initial switch here: https://netbox.readthedocs.io/en/feature/ It likely still needs a bit of polish but looks good.
adam commented 2025-12-29 18:38:04 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 27, 2021):

I think it's fair to consider this done. I'm sure we'll make tweaks as we proceed with regular documentation updates throughout the v2.11 development cycle.

@jeremystretch commented on GitHub (Feb 27, 2021): I think it's fair to consider this done. I'm sure we'll make tweaks as we proceed with regular documentation updates throughout the v2.11 development cycle.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: housekeeping
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#4593
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?