Skip to content

Commit 407b426

Browse files
author
Pablo Panero
committed
versioning: add mike to requirements, install extras, and format entry file
1 parent b0ab112 commit 407b426

File tree

2 files changed

+52
-48
lines changed

2 files changed

+52
-48
lines changed

mkdocs.yml

Lines changed: 51 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,78 @@
11
# Project information
2-
site_name: 'User Documentation'
3-
site_description: 'InvenioRDM user documentation web site'
4-
site_url: 'https://inveniordm.docs.cern.ch'
2+
site_name: User Documentation
3+
site_description: InvenioRDM user documentation web site
4+
site_url: https://inveniordm.docs.cern.ch
55

66
# Repository
7-
repo_name: 'docs-invenio-rdm'
8-
repo_url: 'https://github.com/inveniosoftware/docs-invenio-rdm'
7+
repo_name: docs-invenio-rdm
8+
repo_url: https://github.com/inveniosoftware/docs-invenio-rdm
99

1010
# Copyright
11-
copyright: 'Copyright © 2019-2020 CERN and Northwestern University.'
11+
copyright: Copyright © 2019-2020 CERN and Northwestern University.
1212

1313
# Configuration
1414
theme:
15-
name: 'material'
16-
custom_dir: 'theme'
17-
palette:
18-
primary: 'white'
19-
font:
20-
text: 'Open Sans'
21-
code: 'Roboto Mono'
22-
logo: 'images/logo-rdm.png'
23-
favicon: 'images/favicon.svg'
24-
feature:
25-
tabs: true
15+
name: material
16+
custom_dir: theme
17+
palette:
18+
primary: white
19+
font:
20+
text: Open Sans
21+
code: Roboto Mono
22+
logo: images/logo-rdm.png
23+
favicon: images/favicon.svg
24+
feature:
25+
tabs: true
2626

2727
nav:
28-
- Home: 'index.md'
28+
- Home: index.md
2929
- Install:
30-
- Installation: 'install/index.md'
30+
- Installation: install/index.md
3131
- Preview:
32-
- Quick preview of InvenioRDM: 'preview/index.md'
32+
- Quick preview of InvenioRDM: preview/index.md
3333
- Develop:
34-
- Getting Started: 'develop/index.md'
35-
- Install Locally: 'develop/install_locally.md'
36-
- Run: 'develop/run.md'
37-
- Make it your own: 'develop/make_it_your_own.md'
38-
- Troubleshooting: 'develop/troubleshoot.md'
39-
- Cleanup: 'develop/cleanup.md'
34+
- Getting Started: develop/index.md
35+
- Install Locally: develop/install_locally.md
36+
- Run: develop/run.md
37+
- Make it your own: 'develop/make_it_your_own.md'
38+
- Troubleshooting: develop/troubleshoot.md
39+
- Cleanup: develop/cleanup.md
4040
- Extensions:
41-
- What can be added?: 'extensions/index.md'
42-
- Add your extensions: 'extensions/custom.md'
43-
- S3 Storage: 'extensions/s3.md'
41+
- What can be added?: extensions/index.md
42+
- Add your extensions: extensions/custom.md
43+
- S3 Storage: extensions/s3.md
4444
- Deploy:
45-
- How can I deploy it?: 'deployment/index.md'
46-
- OpenShift: 'deployment/openshift.md'
47-
- Kubernetes: 'deployment/kubernetes.md'
48-
- System components: 'deployment/services.md'
49-
- Configuration: 'deployment/configuration.md'
50-
- Building your image: 'deployment/image.md'
51-
- Image registries: 'deployment/registries.md'
52-
- Benchmarking: 'deployment/benchmark.md'
45+
- How can I deploy it?: deployment/index.md
46+
- OpenShift: deployment/openshift.md
47+
- Kubernetes: deployment/kubernetes.md
48+
- System components: deployment/services.md
49+
- Configuration: deployment/configuration.md
50+
- Building your image: deployment/image.md
51+
- Image registries: deployment/registries.md
52+
- Benchmarking: deployment/benchmark.md
5353

5454

5555
# Customization
5656
extra:
57-
social:
58-
- type: 'github'
59-
link: 'https://github.com/inveniosoftware'
60-
- type: 'twitter'
61-
link: 'https://twitter.com/inveniosoftware'
62-
- type: 'comments'
63-
link: 'https://invenio-talk.web.cern.ch/c/projects/invenio-rdm'
64-
- type: 'globe'
65-
link: 'https://inveniosoftware.org/products/rdm/'
57+
social:
58+
- type: github
59+
link: https://github.com/inveniosoftware
60+
- type: twitter
61+
link: https://twitter.com/inveniosoftware
62+
- type: comments
63+
link: https://invenio-talk.web.cern.ch/c/projects/invenio-rdm
64+
- type: globe
65+
link: https://inveniosoftware.org/products/rdm/
6666
extra_css:
6767
- stylesheets/extra.css
6868

6969
# Extensions
70+
- css/version-select.css
7071
markdown_extensions:
7172
- admonition
7273
- codehilite:
73-
guess_lang: false
74+
guess_lang: false
7475
- toc:
75-
permalink: true
76+
permalink: true
77+
extra_javascript:
78+
- js/version-select.js

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@
88

99
mkdocs>=1.0.4
1010
mkdocs-material>=4.6.0
11+
mike>=0.5.1

0 commit comments

Comments
 (0)