diff --git a/.gitignore b/.gitignore index a80233aa..dcef30d6 100644 --- a/.gitignore +++ b/.gitignore @@ -69,7 +69,11 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ +doc/_build/ +doc/source/api/*.rst + +doc/source/dev/index.rst +doc/source/changelog.rst # PyBuilder .pybuilder/ diff --git a/doc/Makefile b/doc/Makefile index 4eb9bc54..0d2b1269 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -62,8 +62,21 @@ build/generate-stamp: $(wildcard source/reference/*.rst) mkdir -p build touch build/generate-stamp +generate-rst-from-md: + # generate contributing docs + mkdir -p source/dev + pandoc --from=markdown --to=rst --output=source/dev/_index.rst ../CONTRIBUTING.md + echo ".. _devindex:" > source/dev/index.rst + cat source/dev/_index.rst >> source/dev/index.rst + rm source/dev/_index.rst + # generate changelog + pandoc --from=markdown --to=rst --output=source/_changelog.rst ../CHANGELOG.md + echo ".. _changelog:" > source/changelog.rst + cat source/_changelog.rst >> source/changelog.rst + rm source/_changelog.rst + html: api-doc html-build -html-build: generate +html-build: generate generate-rst-from-md mkdir -p build/html build/doctrees $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html $(FILES) @echo diff --git a/doc/source/index.rst b/doc/source/index.rst index 7105736a..ca39a51c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,6 +11,7 @@ Jobflow Remote documentation User Guide API reference Development + Changelog release diff --git a/pyproject.toml b/pyproject.toml index d7e32a54..89a6337c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,8 +3,8 @@ requires = ["setuptools >= 42", "versioningit ~= 1.0", "wheel"] build-backend = "setuptools.build_meta" [project] -name = "jobflow_remote" -description = "jobflow-remote is a python package to run jobflow workflows on remote resources" +name = "jobflow-remote" +description = "Jobflow Remote is a Python package to run jobflow workflows on remote resources" readme = "README.md" keywords = [] license = { text = "modified BSD" } @@ -64,10 +64,10 @@ strict = [] jf = "jobflow_remote.cli.jf:app" [project.urls] -homepage = "https://Matgenix.github.io/jobflow_remote/" -repository = "https://github.com/Matgenix/jobflow_remote" -documentation = "https://Matgenix.github.io/jobflow_remote/" -changelog = "https://github.com/Matgenix/jobflow_remote/CHANGELOG.md" +homepage = "https://Matgenix.github.io/jobflow-remote/" +repository = "https://github.com/Matgenix/jobflow-remote" +documentation = "https://Matgenix.github.io/jobflow-remote/" +changelog = "https://github.com/Matgenix/jobflow-remote/CHANGELOG.md" [tool.setuptools.package-data] jobflow_remote = ["py.typed"]