https://github.com/stackhpc/openstack-admin-guide
Template of an OpenStack administration guide
https://github.com/stackhpc/openstack-admin-guide
Last synced: 14 days ago
JSON representation
Template of an OpenStack administration guide
- Host: GitHub
- URL: https://github.com/stackhpc/openstack-admin-guide
- Owner: stackhpc
- Created: 2020-09-10T14:32:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-11-19T13:05:10.000Z (7 months ago)
- Last Synced: 2025-11-19T13:22:37.032Z (7 months ago)
- Language: Python
- Homepage:
- Size: 1.95 MB
- Stars: 5
- Watchers: 8
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Template of OpenStack administration guide
==========================================
Customise the guide
-------------------
* Fork this repository
* Customise source/vars.rst
* Customise source/data/deployment.yml
Build the guide
---------------
Prepare your build environment:
Please note that Sphinx requires now python version 3.7+. Details: https://github.com/sphinx-contrib/autoprogram/pull/48.
Default python version in CentOS 8 is 3.6. So either you use different distro, or install python 3.7+ manually.
.. code-block:: console
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
Then use one of the following build commands:
.. code-block:: console
make html
make singlehtml
Run ``make`` to see all possible builds.
PDF builds will require extra packages to be installed. For CentOS 8:
.. code-block:: console
sudo dnf install -y epel-release
sudo dnf install -y latexmk make texlive texlive-capt-of texlive-fncychap \
texlive-framed texlive-needspace texlive-tabulary texlive-titlesec \
texlive-upquote texlive-wrapfig
make latexpdf