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

Make readthedocs versionated #4027

New Issue
Closed
opened 2025-12-29 18:32:41 +01:00 by adam · 3 comments
adam commented 2025-12-29 18:32:41 +01:00
Owner
Copy Link

Originally created by @JonasKs on GitHub (Aug 26, 2020).

Change Type

  • Addition
  • Correction
  • Deprecation
  • Cleanup (formatting, typos, etc.)

Area

  • Installation instructions
  • Configuration parameters
  • Functionality/features
  • REST API
  • Administration/development
  • Other

Proposed Changes

Make readthedocs versionated, so that we can read the docs for previous versions of NetBox.

Right now, I'm only able to read the stable documentation:
image

I wish it worked a bit like requests, where I'm able to check out documentation for older versions:
image

Originally created by @JonasKs on GitHub (Aug 26, 2020). <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type * [x] Addition * [ ] Correction * [ ] Deprecation * [ ] Cleanup (formatting, typos, etc.) ### Area * [ ] Installation instructions * [ ] Configuration parameters * [ ] Functionality/features * [ ] REST API * [ ] Administration/development * [x] Other <!-- Describe the proposed change(s). --> ### Proposed Changes Make readthedocs versionated, so that we can read the docs for previous versions of NetBox. Right now, I'm only able to read the `stable` documentation: ![image](https://user-images.githubusercontent.com/5310116/91289272-6ee58b00-e792-11ea-93d9-0a3ce20dc605.png) I wish it worked a bit like `requests`, where I'm able to check out documentation for older versions: ![image](https://user-images.githubusercontent.com/5310116/91289578-d26fb880-e792-11ea-9a48-f23f7dad9943.png)
adam closed this issue 2025-12-29 18:32:41 +01:00
adam commented 2025-12-29 18:32:41 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 26, 2020):

We stopped publishing the documentation for old releases because Google kept sending folks to the outdated versions, leading to a lot of confusion and frustration. We now publish only the current stable release (and beta release, when applicable). The documentation for older releases is still available via GitHub, or locally by installing and running mkdocs serve.

@jeremystretch commented on GitHub (Aug 26, 2020): We stopped publishing the documentation for old releases because Google kept sending folks to the outdated versions, leading to a lot of confusion and frustration. We now publish only the current stable release (and beta release, when applicable). The documentation for older releases is still available via GitHub, or locally by installing and running `mkdocs serve`.
adam commented 2025-12-29 18:32:42 +01:00
Author
Owner
Copy Link

@JonasKs commented on GitHub (Aug 26, 2020):

Ah, makes sense. I’ll build it locally. Cheers!

@JonasKs commented on GitHub (Aug 26, 2020): Ah, makes sense. I’ll build it locally. Cheers!
adam commented 2025-12-29 18:32:42 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 26, 2020):

FYI you can run pip install -r docs/requirements.txt to install mkdocs and its required dependencies.

@jeremystretch commented on GitHub (Aug 26, 2020): FYI you can run `pip install -r docs/requirements.txt` to install `mkdocs` and its required dependencies.
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
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#4027
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?