MinIO uses Sphinx to generate static HTML pages using ReSTructured Text (rST).
-
Python 3.10.X and pip
-
Sphinx 4.3.2
-
NodeJS 14.5.0 or later and npm
-
gulp.js
-
git
or a git-compatible client -
Access to https://github.com/minio/docs
-
Run
git clone https://github.com/minio/docs
andcd docs
to move into the working directory. -
Create a new virtual environment
python3 -m venv venv
. Activate it usingsource venv/bin/activate
. -
Run
pip install -r requirements.txt
to setup the Python environment. -
Run
make stage
-
Open your browser to https://localhost:8000 to view the staged output.
-
Run
git clone https://github.com/minio/docs
andcd docs
to move into the working directory. -
Create a new virtual environment
python3 -m venv venv
. Activate it usingsource venv/bin/activate
. -
Run
pip install -r requirements.txt
to setup the Python environment. -
Run
npm install
-
Run
npm run build
-
Run
make stage
-
Open your browser to https://localhost:8000 to view the staged output.
Prereq:
-
Checkout the MinIO docs repository using your preferred
git
methodgit clone https://github.com/minio/docs
All instructions use PowerShell running as an administrator.
-
Set policies
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
-
Navigate to the folder with the cloned docs
-
Start virtual environment
python -m venv venv
-
Activate virtual environment
.\venv\Scripts\Activate.ps1
-
Install docs requirements
pip install -r requirements.txt
-
(optional) Delete the Build directory
Remove-Item build\
-
Generate CSS from SCSS files
npm run build
-
Build the docs
sphinx-build -M html source\ build\master -n
-
Start the http server
python -m http.server --directory build\master\html
-
View the staged output in a browser by going to
localhost:8000
This project is licensed under a Creative Commons Attribution 4.0 International License.
See CONTRIBUTIONS for more information on contributing content to the MinIO Documentation project.