-
Notifications
You must be signed in to change notification settings - Fork 67
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
enabling versioning of documentation: #45
base: master
Are you sure you want to change the base?
Conversation
We are not using https://github.com/zayd62/mkdocs-versioning/ in the end? Your fix has been merged in. Seems like |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question above about using this over the other plugin...
@@ -1,76 +1,79 @@ | |||
# Project information |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: Does mike auto-rewrite the mkdocs.yml? I am not sure I like this 😅
- type: comments | ||
link: https://invenio-talk.web.cern.ch/c/projects/invenio-rdm | ||
- type: globe | ||
link: https://inveniosoftware.org/products/rdm/ | ||
extra_css: | ||
- stylesheets/extra.css | ||
|
||
# Extensions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor: misalignment of the comment I think
permalink: true | ||
permalink: true | ||
extra_javascript: | ||
- js/version-select.js |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
moderate: Are indentation: 4 spaces or 2 spaces?
Closes #44
Instructions have been moved to the README file.
Open Questions:
from ruamel.yaml.util import load_yaml_guess_indent
in theinstall_extras
command. Somehow it is interpreting 4 spaces instead of 2.install
tab instead of thehome
one. This can be modified in thedocs/js/version-select.js
and it is easy to do. However, we can just put it somewhere different, top corners? bottom corners? WDYT?Example:
https://ppanero.github.io/docs-invenio-rdm/0.7.0/
https://ppanero.github.io/docs-invenio-rdm/0.7.1/
https://ppanero.github.io/docs-invenio-rdm/latest/ --> points to https://ppanero.github.io/docs-invenio-rdm/0.7.1/
https://ppanero.github.io/docs-invenio-rdm/ --> redirect to https://ppanero.github.io/docs-invenio-rdm/latest