Update README #895
Update README #895
Conversation
michael-wisely-gravwell
force-pushed
the
update-readme
branch
from
df07da4 to
85eec44
Compare
README.md
Outdated
| ├─ 404.html | ||
| ├─ index.html | ||
| ├─ ... | ||
| ├─ v5.4.4 <- the full build of v5.4.4 |
There was a problem hiding this comment.
should this have / after v5.4.4 to indicate a directory (like docs/ above)?
README.md
Outdated
| │ ├─ 404.html | ||
| │ ├─ index.html | ||
| │ ├─ ... | ||
| ├─ v5.4.3 <- the full build of v5.4.3 |
There was a problem hiding this comment.
should this have / after v5.4.3 to indicate a directory (like docs/ above)?
README.md
Outdated
| 2. Rename `docs/` to `vN.N.N+1` (or whatever version it is) | ||
| 3. Add the docs for the new version in `docs/` | ||
| - Don't forget to update `_static/versions.json`! | ||
| 4. Move all `v.N.N.N` and `vN.N.N+1` back into `docs/` |
There was a problem hiding this comment.
This could maybe use a little more clarification.
-
Do you want to Copy (meaning the original stays where it is)?
so that in... -
the
docs/directory that we rename still has all the previous versions in it also? -
There is no
docs/directory after it was renamed in 2, so I don't know if we want to simply say Add the docs to that location. Probably obvious enough, but I don't think the language is precise. -
I had to read this more than once. I get it, but maybe there is an easier way to explain?
I thought your tree outline above clearly demonstrates the desired outcome though, so I am able to reason through the intent here.
There was a problem hiding this comment.
Maybe these steps are overkill. There's more than one way to accomplish the task.
In the end, all that matters is the directory structure, which is outlined.
README.md
Outdated
|
|
||
| ``` | ||
| docs/ | ||
| ├─ latest/ <- a link to v5.4.5 |
There was a problem hiding this comment.
I am sure you have tested this and it works, but does latest here need any further explanation since latest isn't in the URL and isn't mentioned in the first tree outline?
README.md
Outdated
|
|
||
| As implied by the path, only the `versions.json` that's included in the latest docs version needs to be up-to-date. It doesn't matter if any `.../vN.N.N/_static/versions.json` is out of date. Only the file at `/_static/verions.json` is used. | ||
|
|
||
| The [PyData Sphinx Theme docs](https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html#add-a-json-file-to-define-your-switcher-s-versions) explain the optins in more detail, but here's a quick summary / example: |
There was a problem hiding this comment.
| The [PyData Sphinx Theme docs](https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html#add-a-json-file-to-define-your-switcher-s-versions) explain the optins in more detail, but here's a quick summary / example: | |
| The [PyData Sphinx Theme docs](https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html#add-a-json-file-to-define-your-switcher-s-versions) explain the options in more detail, but here's a quick summary / example: |
This PR is related to #838
This PR proposes an update to the README, explaining how deployment works with the new version switcher changes.