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

Include docs in main release package #4857

New Issue
Closed
opened 2025-12-29 19:21:18 +01:00 by adam · 1 comment
adam commented 2025-12-29 19:21:18 +01:00
Owner
Copy Link

Originally created by @jcralbino on GitHub (May 1, 2021).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v2.11

Feature type

New functionality

Proposed functionality

Include the HTML rendered online documentation available on https://netbox.readthedocs.io/en/stable/ within the main package of the netbox.

The goal is to adapt the URL seen bellow to the HTML local documentation and have it as rendered docs available at /docs on a live instance
image

Use case

The following use cases are applicable:

  • Provide the correct documentation that is always related to the specific version being used, instead of the online version that refers the latest version.
  • Provide access to the documentation to system installed in a isolated management environment that do not have internet access.

Database changes

none.
Only file structure changes to create a new /docs directory and changing the url.

External dependencies

No response

Originally created by @jcralbino on GitHub (May 1, 2021). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v2.11 ### Feature type New functionality ### Proposed functionality Include the HTML rendered online documentation available on https://netbox.readthedocs.io/en/stable/ within the main package of the netbox. The goal is to adapt the URL <Docs> seen bellow to the HTML local documentation and have it as rendered docs available at /docs on a live instance ![image](https://user-images.githubusercontent.com/44149262/116776610-85528d80-aa69-11eb-9543-d234960a13c3.png) ### Use case The following use cases are applicable: * Provide the correct documentation that is always related to the specific version being used, instead of the online version that refers the latest version. * Provide access to the documentation to system installed in a isolated management environment that do not have internet access. ### Database changes none. Only file structure changes to create a new /docs directory and changing the url. ### External dependencies _No response_
adam added the status: acceptedtype: feature labels 2025-12-29 19:21:18 +01:00
adam closed this issue 2025-12-29 19:21:18 +01:00
adam commented 2025-12-29 19:21:19 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 8, 2021):

It seems like the best way to approach this is to have the upgrade script build the docs locally. This means that mkdocs and its related packages (see docs/requirements.txt) will become required dependencies.

We'll also need to tweak the way static file collection is currently handled, introducing a new docs/ path for the rendered documentation.

@jeremystretch commented on GitHub (Jul 8, 2021): It seems like the best way to approach this is to have the upgrade script build the docs locally. This means that `mkdocs` and its related packages (see `docs/requirements.txt`) will become required dependencies. We'll also need to tweak the way static file collection is currently handled, introducing a new `docs/` path for the rendered documentation.
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: feature
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#4857
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?