mirror of
https://github.com/gluster/glusterdocs.git
synced 2026-02-05 15:47:01 +01:00
Add a quick doc on how to build the doc
This commit is contained in:
12
README.md
12
README.md
@@ -2,3 +2,15 @@
|
||||
|
||||
Source code to gluster documentation: http://gluster.readthedocs.io
|
||||
|
||||
# Building the docs
|
||||
|
||||
If you are on EPEL 7 or Fedora, the first thing you will need is to install
|
||||
mkdocs, with the following command (replace yum by dnf on Fedora):
|
||||
|
||||
# yum install mkdocs
|
||||
|
||||
Then you need to run mkdocs from the root of that repository:
|
||||
|
||||
$ mkdocs build
|
||||
|
||||
The result will be in the site/ subdirectory, in HTML
|
||||
|
||||
Reference in New Issue
Block a user