DOC Add versions and use pydata theme #173
Conversation
.github/workflows/deploy-docs.yml
Outdated
| uses: JamesIves/[email protected] | ||
| with: | ||
| branch: gh-pages | ||
| folder: doc/_build/html | ||
| target-folder: dev | ||
| clean: true | ||
|
|
||
| - name: Deploy stable docs 🚀 | ||
| uses: JamesIves/[email protected] | ||
| if: startsWith(${{ github.ref_name }}, 'v*') |
.github/workflows/deploy-docs.yml
Outdated
| DOC_DIR="$(cut -d '.' -f 1,2 <<< "$TAG")" | ||
| echo "DOC_DIR=${DOC_DIR:1}".x >> $GITHUB_ENV |
There was a problem hiding this comment.
couldn't figure out how to make this a one liner, suggestions welcome. Works as is and outputs e.g., "0.1.x"
doc/_static/version_switcher.json
Outdated
| [ | ||
| { | ||
| "version": "0.1.x", | ||
| "url": "https://jni.github.io/skan/0.1.x" |
There was a problem hiding this comment.
not sure how the url's work so not sure if this works, pydata docs didn't expand. @jni can you explain..?
There was a problem hiding this comment.
Probably can replace this with skeleton-analysis.org instead of jni.github.io/skan. But I think both will work, because jni.github.io/skan/whatever.html automatically resolves to skeleton-analysis.org/whatever.html. In fact what you've got is probably the optimum choice because it'll be stable even if the domain lapses.
There was a problem hiding this comment.
For each of these we need to go back and build the old docs though, and the early versions are pointless. I would say let's go back to 0.7.x and no more, as that is the version matching the paper.
There was a problem hiding this comment.
I kept jni.github.io/skan because that is what is used everywhere else in the config file. So keep as is then?
|
Supposedly subsections should be in the left navigation bar by default. but it seems to be at the top?
I think I have removed all alabaster config lines and hopefully it should be a default build of pydata theme now |
lucyleeow
changed the title
| @@ -133,28 +136,22 @@ | |||
| 'repo_url': 'https://github.com/jni/skan/', | |||
| 'repo_name': 'Skan', | |||
|
|
|||
| # Visible levels of the global TOC; -1 means unlimited | |||
There was a problem hiding this comment.
I think this may be from alabaster theme
|
I think this is ready for review and merge. I thought it would be best to get this in first before doing the branch 0.10.x, as we want the version switcher json file in gh-pages |
|
I've realised I need to fix version matching here. |
Supersedes #172
Add versions to doc and switch to using pydata theme
https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/configuring.html?highlight=version#add-a-dropdown-to-switch-between-docs-versions