From 385232dc8da6532b54342cd11e6d822ff7cd3e5a Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Sat, 7 Sep 2019 02:27:45 +0000 Subject: doc: document doc, create makefile and tox target MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Create makefile and tox targets for documentation building and testing to better replicate the live web docs using the same theme. * Created docs.rst to explain how to build and contribute to documentation with style guide and tips. * doc/rtd/conf.py:     * Add copyright to rtd config     * Use Sphinx's RTD theme to replicate actual docs --- Makefile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 4ace2270..2c6d0c80 100644 --- a/Makefile +++ b/Makefile @@ -106,7 +106,9 @@ deb-src: echo sudo apt-get install devscripts; exit 1; } $(PYVER) ./packages/bddeb -S -d +doc: + tox -e doc .PHONY: test pyflakes pyflakes3 clean pep8 rpm srpm deb deb-src yaml .PHONY: check_version pip-test-requirements pip-requirements clean_pyc -.PHONY: unittest unittest3 style-check +.PHONY: unittest unittest3 style-check doc -- cgit v1.2.3 From ac8ef3eed1ca78d779b9fc414439e5dc4153735c Mon Sep 17 00:00:00 2001 From: Chad Smith Date: Wed, 18 Sep 2019 10:31:35 +0000 Subject: tools: make clean now cleans the dev directory, not the system Remove pyc files, .tox directories and docs during make clean. --- Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 2c6d0c80..315e6b45 100644 --- a/Makefile +++ b/Makefile @@ -80,9 +80,10 @@ config/cloud.cfg: clean_pyc: @find . -type f -name "*.pyc" -delete + @find . -type d -name __pycache__ -delete clean: clean_pyc - rm -rf /var/log/cloud-init.log /var/lib/cloud/ + rm -rf doc/rtd_html .tox .coverage yaml: @$(PYVER) $(CWD)/tools/validate-yaml.py $(YAML_FILES) -- cgit v1.2.3