Browse Source

Update to sphinx 4

pull/428/head
Ravind Kumar 3 years ago
committed by Ravind Kumar
parent
commit
b15493e2f9
  1. 3
      .gitignore
  2. 9
      README.md
  3. 6
      requirements.txt
  4. 1124
      source/_static/css/main.css
  5. 1
      source/_static/css/main.min.css
  6. 6
      source/_static/scss/includes/_aside.scss

3
.gitignore

@ -1,7 +1,10 @@
build
venv
sphinx4
.vscode
__pycache__
node_modules
npm-debug.log
.python-version
main.min.css
main.css

9
README.md

@ -7,9 +7,7 @@ static HTML pages using ReSTructured Text.
## Prerequisites
- Python 3.9.X.
*NOTE*: Pythoon 3.10 does not work with the version of Sphinx (3.5.0) used by the MinIO Docs. Newer versions of Sphinx which are compatible with Python 3.10 break the current site layout. Please use Python 3.9.X for building the MinIO documentation.
- Python 3.10.X.
- NodeJS 14.5.0 or later.
@ -30,10 +28,9 @@ using the following instructions as general guidance.
3. Run `pip install -r requirements.txt` to setup the Python environment.
4. Run `make html`
4. Run `make stage`
5. Run `python -m http.server --directory build/BRANCH/html`. Open your
browser to the output URL to view the staged output.
5. Open your browser to http://localhost:8000 to view the staged output.
This project is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/legalcode).

6
requirements.txt

@ -1,9 +1,9 @@
docutils == 0.17
sphinx == 3.5.0
sphinx == 4.3.2
sphinx-copybutton == 0.4.0
sphinx-design == 0.0.12
sphinx-design == 0.0.13
sphinx-markdown-tables == 0.0.15
Sphinx-Substitution-Extensions == 2020.9.30.0
sphinx-togglebutton === 0.2.3
sphinx-togglebutton === 0.3.0
sphinxcontrib-images === 0.9.4
myst-parser === 0.16.1

1124
source/_static/css/main.css
File diff suppressed because it is too large
View File

1
source/_static/css/main.min.css
File diff suppressed because it is too large
View File

6
source/_static/scss/includes/_aside.scss

@ -1,4 +1,4 @@
.sidebar {
div.sidebar,aside.sidebar {
width: $sidebar-width;
position: fixed;
left: 0;
@ -30,7 +30,7 @@
}
}
.sidebar-active {
div.sidebar-active {
.sidebar {
@include breakpoint-min(breakpoints(xl)) {
transform: translate3d(-100%, 0, 0);
@ -47,7 +47,7 @@
}
}
.sidebar__title {
div.sidebar__title {
margin: -0.25rem 0 1.5rem;
line-height: 100%;

Loading…
Cancel
Save