Store the docs database as fixtures instead of an sqlite database.
Review Request #4531 — Created Sept. 5, 2013 and submitted
Store the docs database as fixtures instead of an sqlite database.
The docs database was painful to merge and update, and sometimes stray
items (from operations that deal with in-database caches) would get
committed. It also outright failed when there were evolutions that
needed to be applied, always.Now, building any docs target for the manual will rebuild the docs db
from a fixture, if the fixture has changed or if the database is
missing. When adding new items to the database, a modified docs.db can
be dumped using ./scripts/dumpdata.sh.This should help going forward with some annoyances with our docs
builds.
Deleted the database and built the docs. Did that again a couple more times.
-
This is a review from Review Bot.
Tool: Pyflakes
Processed Files:
Ignored Files:
docs/manual/scripts/dumpdata.sh
docs/manual/Makefile
docs/manual/fixtures/initial_data.json
docs/manual/docs.db
- Change Summary:
-
The database is no longer deleted every time the docs are built, helping with
the process of iteratively testing new items for the database. It will just
get rebuilt if missing or if the fixtures have changed. - Description:
-
Store the docs database as fixtures instead of an sqlite database.
The docs database was painful to merge and update, and sometimes stray
items (from operations that deal with in-database caches) would get committed. It also outright failed when there were evolutions that needed to be applied, always. ~ Now, building any docs target for the manual will rebuild the docs data
~ from a fixture. When adding new items to the database, a modified ~ docs.db can be dumped using ./scripts/dumpdata.sh. ~ Now, building any docs target for the manual will rebuild the docs db
~ from a fixture, if the fixture has changed or if the database is ~ missing. When adding new items to the database, a modified docs.db can + be dumped using ./scripts/dumpdata.sh. This should help going forward with some annoyances with our docs
builds.
-
This is a review from Review Bot.
Tool: PEP8 Style Checker
Processed Files:
Ignored Files:
docs/manual/scripts/dumpdata.sh
docs/manual/Makefile
docs/manual/fixtures/initial_data.json
docs/manual/docs.db