f8408e2720
Alembic offers the following functionality: - Can emit ALTER statements to a database in order to change the structure of tables and other constructs - Provides a system whereby "migration scripts" may be constructed; each script indicates a particular series of steps that can "upgrade" a target database to a new version, and optionally a series of steps that can "downgrade" similarly, doing the same steps in reverse. - Allows the scripts to execute in some sequential manner. 1. Add Alembic migrations support. 2. Move 001_manila_init.py migration to manila/db/sqlalchemy/alembic/versions/162a3e673105_manila_init.py. 3. Remove manila/db/sqlalchemy/migrate_repo directory. 4. Fix unit tests. 5. Add ability to runtime updrade/downgrade db. Implements bp alembic-instead-of-sqlalchemy-migrate Change-Id: Iadc0d9596e826323ba19bd25be741c401b90b688 |
||
---|---|---|
.. | ||
ext | ||
source | ||
.gitignore | ||
Makefile | ||
README.rst | ||
find_autodoc_modules.sh | ||
generate_autodoc_index.sh |
README.rst
Building the docs
Dependencies
- Sphinx
-
You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the manila modules.
pip install Sphinx
- Graphviz
-
Some of the diagrams are generated using the
dot
language from Graphviz.sudo apt-get install graphviz
Use make
Just type make:
% make
Look in the Makefile for more targets.
Manually
Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.sh > source/code.rst
Run `sphinx_build`:
% sphinx-build -b html source build/html
The docs have been built
Check out the build directory to find them. Yay!