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

documentation: support versioned docs #1881

Closed
protobits opened this issue Sep 23, 2020 · 0 comments · Fixed by #2408
Closed

documentation: support versioned docs #1881

protobits opened this issue Sep 23, 2020 · 0 comments · Fixed by #2408
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@protobits
Copy link
Contributor

As previously discussed, the sphinx documentation on the nuttx website should offer a version selector to allow reading docs for master ("latest") or for past releases (starting from following one).

While there's already some basic skeleton to allow for this (I added an HTML template that appears on the sidebar), we need add some code to conf.py so that it picks up the list of releases we would like to offer. It could either be based on running some git commands from that script or it could read an environment variable set by the workflow with the same information.

This would simply fill the sidebar with links like nuttx.apache.org/docs/. A subsequent PR should also build the documentation for each release as well (probably by adding a trigger to act on pushes to release branches or tags, depending on how we want to deal with that).

Note that we cannot simply add a hardcoded list to conf.py since this would mean that the rendered version of docs for each release would only "know" about the past releases at that time. Thus, this information needs to be generated during build so that all versions of the documentation have links to all other offered versions.

@protobits protobits added the documentation Improvements or additions to documentation label Sep 23, 2020
@protobits protobits added this to the v10.0 milestone Sep 23, 2020
@protobits protobits self-assigned this Sep 23, 2020
@protobits protobits linked a pull request Nov 26, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant