Split the docs #1963
Merged
Split the docs #1963
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nto split-the-docs
That value controls what appears in the top left corner of the built html docs.
CHANGELOG split is being handled in a separate PR
We should use redirects in the ReadTheDocs project for that.
ni-jfitzger
changed the title
|
I have decided to revert changes related to independent versioning and restrict this to changes needed for the doc split. |
- Gives us better control over how documentation is built. - Allows contributors who don't have the readthedocs maintenance permission to update the configuration (with permission from repo maintainers)
…e original ReadTheDocs projct.
ni-jfitzger
changed the title
Any codegen'd file should be delete by make clean
marcoskirsch
requested changes
Jun 2, 2023
|
Very little feedback on my part, I think it will be more efficient to push this in and then we can do a pass on how things look and what outdated stuff remains or what needs to be reworded. This is great! |
marcoskirsch
approved these changes
Jun 2, 2023
ni-jfitzger
added a commit
to ni-jfitzger/nimi-python
that referenced
this pull request
Jun 12, 2023
Note: In previous releases, there was only 1 LATEST_RELEASE file. As part of ni#1963 it was split into files for each api, in preparation for independently versioned packages and docs.
marcoskirsch
pushed a commit
that referenced
this pull request
Jun 12, 2023
* Update CHANGELOG.md for nimi-python 1.4.5 release * Update version to 1.4.5 Note: In previous releases, there was only 1 LATEST_RELEASE file. As part of #1963 it was split into files for each api, in preparation for independently versioned packages and docs. * update generated files for 1.4.5 release * Remove .dev0 from old nimi-python readthedocs project conf.py version
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[ ] I've updated CHANGELOG.md if applicable.[ ] I've added tests applicable for this pull requestWhat does this Pull Request accomplish?
To have different readthedocs pages for each of the driver modules in nimi-python. Clients don't care about
nimi-python, theypip install nidmm(or some other module) and would expect to find the documentation fornidmmnotnimi-python.This change also paves the road toward individual
nimi-pythonpackages to maintain independent versions, following semver guidance, and release independently. This will allow patch-fix releases to be made more easily.Major Changes:
docs/<module>.rstinto module-specific folders, and began generating them from driver.rst.mako (becausetox -e cleandeletes that folderdocs/index.rstintodocs/<module>/index.rstfiles generated from a template.src/<module>/List issues fixed by this Pull Request below, if any.
What testing has been done?
See the links to the built documentation.
TODOs