MinIO uses Sphinx to generate static HTML pages using ReSTructured Text.
-
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.
-
NodeJS 14.5.0 or later.
-
gitor a git-compatible client. -
Access to https://github.com/minio/docs
All instructions below are intended for Linux systems. Windows builds may work using the following instructions as general guidance.
-
Run
git checkout https://github.com/minio/docsandcd docsto 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.txtto setup the Python environment. -
Run
make html -
Run
python -m http.server --directory build/BRANCH/html. Open your browser to the output URL to view the staged output.
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.