This repository contains documentation to aid operators and users of OpenStack clouds powered by Pure Storage FlashArray.
The latest build of this documentation is live here:
https://pure-storage-openstack-docs.readthedocs.io/en/latest/
We welcome contributions and requests for enhancement. If you find bugs in the documentation, please file an issue. You may also do this from within the documentation webpage, using the bug links provided on each page.
This documentation is written and built with Sphinx using reStructured Text as the markup language.
To build this guide, you will need tox.
Install tox by running:
pip install tox
From inside the repository, build this guide with:
tox -e docs
It requires PyEnchant installation. On Ubuntu:
sudo apt install python3-enchant
A "build" folder is created with doctrees and html output.
If you're building this on macOS, it is possible you'll run into dependency issues if you do not have Xcode Command Line utilities enabled. You can enable it with:
xcode-select --install
The theme used by the builds of this documentation was developed by the OpenStack community.