diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..420baaf4e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,88 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf _build/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html + @echo + @echo "Build finished. The HTML pages are in _build/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml + @echo + @echo "Build finished. The HTML pages are in _build/dirhtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in _build/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in _build/qthelp, like this:" + @echo "# qcollectiongenerator _build/qthelp/Gramps.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile _build/qthelp/Gramps.qhc" + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex + @echo + @echo "Build finished; the LaTeX files are in _build/latex." + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ + "run these through (pdf)latex." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes + @echo + @echo "The overview file is in _build/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in _build/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in _build/doctest/output.txt." diff --git a/gramps/webapp/Makefile b/gramps/webapp/Makefile new file mode 100644 index 000000000..650bed89e --- /dev/null +++ b/gramps/webapp/Makefile @@ -0,0 +1,70 @@ +# Initialize GRAMPS Django site + +update: grampsdb/fixtures/initial_data.json + PYTHONPATH=../.. python manage.py syncdb --noinput + PYTHONPATH=../.. python manage.py createsuperuser --username=admin --email=bugs@gramps-project.org + PYTHONPATH=../.. python manage.py createsuperuser --username=admin1 --email=bugs@gramps-project.org + +grampsdb/fixtures/initial_data.json: init.py + PYTHONPATH=../.. python init.py > grampsdb/fixtures/initial_data.json + +init_gramps: + PYTHONPATH=../.. python init_gramps.py # clear primary and secondary tables + +run: + PYTHONPATH=../.. python manage.py runserver + +sql: + PYTHONPATH=../.. python manage.py sqlall > gramps-sql.sql + +dump: + echo ".dump" | sqlite3 sqlite.db > gramps-data.sql + +load: + sqlite3 sqlite.db < gramps-data.sql + +superusers: + PYTHONPATH=../.. python manage.py createsuperuser --username=admin --email=bugs@gramps-project.org + PYTHONPATH=../.. python manage.py createsuperuser --username=admin1 --email=bugs@gramps-project.org + +backup: + PYTHONPATH=../.. python manage.py dumpdata > backup.json + +restore: empty + PYTHONPATH=../.. python manage.py loaddata backup.json + +initial_data: + PYTHONPATH=../.. python manage.py loaddata grampsdb/fixtures/initial_data.json + +docs: + mkdir -p docs + python manage.py graph_models grampsdb -i Person,Family,Source,Event,Repository,Place,Media,Note -o docs/primary-tables.png + python manage.py graph_models grampsdb -i Note -o docs/note-table.png + python manage.py graph_models grampsdb -i Media -o docs/media-table.png + python manage.py graph_models grampsdb -i Place -o docs/place-table.png + python manage.py graph_models grampsdb -i Repository -o docs/repository-table.png + python manage.py graph_models grampsdb -i Event -o docs/event-table.png + python manage.py graph_models grampsdb -i Source -o docs/source-table.png + python manage.py graph_models grampsdb -i Family -o docs/family-table.png + python manage.py graph_models grampsdb -i Person -o docs/person-table.png + python manage.py graph_models grampsdb -o docs/all-tables.png + python manage.py graph_models grampsdb -i Attribute,Datamap,Name,Lds,Tag,Address,Location,Url -o docs/secondary-tables.png + python manage.py graph_models grampsdb -i Person,Family,Source,Event,Repository,Place,Media,Note,Attribute,Datamap,Name,Lds,Tag,Address,Location,Url -o docs/prim-sec-tables.png + python manage.py graph_models grampsdb -i Person,Family,Source,Event,Repository,Place,Media,Note,Attribute,Datamap,Name,Lds,Tag,Address,Location,Url -o docs/prim-sec-tables.png + python manage.py graph_models grampsdb -i Person,Family,Source,Event,Repository,Place,Media,Note,Attribute,Datamap,Name,Lds,Tag,Address,Location,Url,NoteRef,SourceRef,EventRef,RepositoryRef,PersonRef,ChildRef,MediaRef -o docs/prim-sec-ref-tables.png + +make-empty: + echo ".dump" | sqlite3 sqlite.db > empty.sql + +empty: + rm -f sqlite.db + sqlite3 sqlite.db < empty.sql + +example: + rm -f sqlite.db + sqlite3 sqlite.db < example.sql + +clean: + rm -f sqlite.db + rm -f *~ *.pyc *.pyo + rm -f grampsdb/fixtures/initial_data.json