Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include docs in main release package #6328

Closed
jcralbino opened this issue May 1, 2021 · 1 comment
Closed

Include docs in main release package #6328

jcralbino opened this issue May 1, 2021 · 1 comment
Assignees
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Milestone

Comments

@jcralbino
Copy link

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

@jcralbino jcralbino added the type: feature Introduction of new functionality to the application label May 1, 2021
@jcralbino jcralbino changed the title 0 1 Include docs in main release Include docs in main release May 1, 2021
@jcralbino jcralbino changed the title Include docs in main release Include docs in main release package May 1, 2021
@jeremystretch jeremystretch added the status: accepted This issue has been accepted for implementation label May 3, 2021
@jeremystretch jeremystretch added this to the v2.12 milestone May 3, 2021
@jeremystretch
Copy link
Member

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 added a commit that referenced this issue Jul 19, 2021
jeremystretch added a commit that referenced this issue Jul 19, 2021
* Incorporate local documentation build in upgrade script

* Add docs build to CI

* Include docs build path in revision control

* Update footer dcos link

* Changelog for #6328

* Clean up errant links
@jeremystretch jeremystretch self-assigned this Jul 19, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Development

No branches or pull requests

2 participants