Comments (13)
Seems it is not compatible with the latest Sphinx as documented here sphinx-contrib/sphinxcontrib-versioning#39
from ood-documentation.
Another option would be to build the different versions of the documentation in sub-directories of docs/
.
docs/latest/...
=> https://osc.github.io/ood-documentation/latest/...docs/v1.0/...
=> https://osc.github.io/ood-documentation/v1.0/...
Similar to:
- http://guides.rubyonrails.org/v4.1/
- http://guides.rubyonrails.org/v4.2/
- http://guides.rubyonrails.org/v5.0/
from ood-documentation.
If we do the above route though, maybe it is best to keep the builds within the branch gh-pages
and include a build script that builds all the versioned branches.
from ood-documentation.
I like this idea, following the Rails convention.
from ood-documentation.
We should also have a /latest/ being a copy of the latest tag i.e. in rails example:
- http://guides.rubyonrails.org/v4.1/
- http://guides.rubyonrails.org/v4.2/
- http://guides.rubyonrails.org/v5.0/
- http://guides.rubyonrails.org/latest/ => same as http://guides.rubyonrails.org/v5.0/
- http://guides.rubyonrails.org/master/ => master branch HEAD
- http://guides.rubyonrails.org/some-branch/ => some-branch HEAD
from ood-documentation.
With /latest/ we will be able to share this link.
from ood-documentation.
The /latest/
trick may require human intervention (e.g., creating a redirect in the /latest/index.html
file to a version of our choosing).
Unless symlinks work, but I doubt it.
from ood-documentation.
No symlinks and no redirect. Just cp -r from vX.Y to latest ( or better, rsync to mirror).
Would need routine to determine the latest release branch available and then match that against the current branch
from ood-documentation.
You would have to manually cp -r
for the first time followed by a git commit and push, and then modify the Travis CI script in that defined latest branch to rm -fr latest
and cp -r
again every time that specific branch is modified.
from ood-documentation.
So the psuedo code is:
if CURRENT_BRANCH == LATEST_VERSION
rm -rf latest if latest.directory_exists?
cp -r CURRENT_BRANCH latest
end
I don't see the manual step.
from ood-documentation.
I guess you create and push a branch. The manual step is triggering Travis to run the build on that branch?
from ood-documentation.
Ah, you actually want the code to scan all the branch names and determine the latest version, I misunderstood the first time.
from ood-documentation.
This is now supported after many trial and errors.
from ood-documentation.
Related Issues (20)
- Replace NavConfig documentation
- docs for vnc_container HOT 4
- Doc Building and Synchronization
- Remove `htcacheclean` references
- [release_2.0] Upgrade to NodeJS 14 HOT 1
- Remove 2.1 related content for SC Doc Release HOT 2
- enable reverse proxy documentation confusing HOT 2
- Call out supported OSes
- Add Documentation Around Fugaku's fujitsu_tcs Adapter
- Update Build Instructions for Pipenv HOT 5
- Add Podman Build Instructions
- Auto groups HOT 1
- Outdated App Sharing Documentation HOT 2
- added configuration to hide app version for batch connects apps
- Update Duo and Keycloak docs
- The 'OSC/ood-documentation' repository doesn't contain the 'source/authentication/nsf-access.rst' path in 'develop'. HOT 2
- 'edit on GH' button redirects to develop. should be latest.
- add docs for allowed hosts
- updates around monitoring HOT 1
- docs for ood disable_welcome_message
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ood-documentation.