Skip to content

Include docs in main release package #6328

@jcralbino

Description

@jcralbino

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

Metadata

Metadata

Assignees

Labels

status: acceptedThis issue has been accepted for implementationtype: featureIntroduction of new functionality to the application

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions