diff --git a/.gitignore b/.gitignore index 06becddac..a9fe39ffc 100644 --- a/.gitignore +++ b/.gitignore @@ -85,9 +85,6 @@ instance/ # Scrapy stuff: .scrapy -# Sphinx documentation -docs/_build/ - # PyBuilder .pybuilder/ target/ diff --git a/README.md b/README.md index 17a739490..fb2839da6 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ The directory structure of your new project will look something like this (depen │ ├── processed <- The final, canonical data sets for modeling. │ └── raw <- The original, immutable data dump. │ -├── docs <- A default Sphinx project; see sphinx-doc.org for details +├── docs <- A default mkdocs project; see mkdocs.org for details │ ├── models <- Trained and serialized models, model predictions, or model summaries │ diff --git a/ccds.json b/ccds.json index b73f0def7..2ad0a0ee2 100644 --- a/ccds.json +++ b/ccds.json @@ -11,7 +11,7 @@ {"s3": {"bucket": "bucket-name", "aws_profile": "default"}}, {"gcs": {"bucket": "bucket-name"}} ], - "environment_manager" : [ + "environment_manager": [ "virtualenv", "conda", "pipenv", @@ -27,5 +27,6 @@ "basic" ], "open_source_license": ["No license file", "MIT", "BSD-3-Clause"], + "docs": ["mkdocs", "none"], "include_code_scaffold": ["Yes", "No"] -} +} \ No newline at end of file diff --git a/docs/docs/index.md b/docs/docs/index.md index a2f663f5f..e93e88706 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -54,7 +54,7 @@ Disagree with a couple of the default folder names? Working on a project that's ## Getting started -With this in mind, we've created a data science cookiecutter template for projects in Python. Your analysis doesn't have to be in Python, but the template does provide some Python boilerplate that you'd want to remove (in the `{{ cookiecutter.module_name }}` folder for example, and the Sphinx documentation skeleton in `docs`). +With this in mind, we've created a data science cookiecutter template for projects in Python. Your analysis doesn't have to be in Python, but the template does provide some Python boilerplate that you'd want to remove (in the `{{ cookiecutter.module_name }}` folder for example, and the mkdocs documentation skeleton in `docs`). > ℹ️ Cookiecutter Data Science v2 has changed from v1. It now requires installing the new cookiecutter-data-science Python package, which extends the functionality of the [cookiecutter](https://cookiecutter.readthedocs.io/en/stable/README.html) templating utility. Use the provided `ccds` command-line program instead of `cookiecutter`. @@ -99,7 +99,7 @@ The directory structure of your new project will look something like this (depen │ ├── processed <- The final, canonical data sets for modeling. │ └── raw <- The original, immutable data dump. │ -├── docs <- A default Sphinx project; see sphinx-doc.org for details +├── docs <- A default mkdocs project; see www.mkdocs.org for details │ ├── models <- Trained and serialized models, model predictions, or model summaries │ diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index 36632a5bc..e54f77cb9 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -47,6 +47,22 @@ "python-dotenv", ] +# Use the selected documentation package specified in the config, +# or none if none selected +docs_path = Path("docs") +# {% if cookiecutter.docs != "none" %} +packages += ["{{ cookiecutter.docs }}"] +pip_only_packages += ["{{ cookiecutter.docs }}"] +docs_subpath = docs_path / "{{ cookiecutter.docs }}" +for obj in docs_subpath.iterdir(): + shutil.move(str(obj), str(docs_path)) +# {% endif %} + +# Remove all remaining docs templates +for docs_template in docs_path.iterdir(): + if docs_template.is_dir() and not docs_template.name == "docs": + shutil.rmtree(docs_template) + # # POST-GENERATION FUNCTIONS # diff --git a/tests/conftest.py b/tests/conftest.py index 9e4d63df6..7e9913874 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -3,7 +3,7 @@ import sys import tempfile from contextlib import contextmanager -from itertools import product +from itertools import cycle, product from pathlib import Path import pytest @@ -19,8 +19,6 @@ "module_name": "project_module", "author_name": "DrivenData", "description": "A test project", - "open_source_license": "MIT", - "dataset_storage": {"azure": {"container": "container-name"}}, } @@ -58,14 +56,23 @@ def _is_valid(config): # remove invalid configs configs = [c for c in configs if _is_valid(c)] - include_code_scaffold = True + + # cycle over all values other multi-select fields that should be inter-operable + # and that we don't need to handle with combinatorics + cycle_fields = [ + "dataset_storage", + "open_source_license", + "include_code_scaffold", + "docs", + ] + cyclers = {k: cycle(cookiecutter_json[k]) for k in cycle_fields} for ind, c in enumerate(configs): config = dict(c) config.update(default_args) # Alternate including the code scaffold - config["include_code_scaffold"] = "Yes" if include_code_scaffold else "No" - include_code_scaffold = not include_code_scaffold + for field, cycler in cyclers.items(): + config[field] = next(cycler) config["repo_name"] += f"-{ind}" yield config diff --git a/tests/test_creation.py b/tests/test_creation.py index 6a60bc25b..3c572a620 100644 --- a/tests/test_creation.py +++ b/tests/test_creation.py @@ -60,6 +60,9 @@ def verify_folders(root, config): f"{config['module_name']}/visualization", ] + if config["docs"] == "mkdocs": + expected_dirs += ["docs/docs"] + expected_dirs = [ # (root / d).resolve().relative_to(root) for d in expected_dirs Path(d) @@ -86,12 +89,7 @@ def verify_files(root, config): "data/interim/.gitkeep", "data/processed/.gitkeep", "data/raw/.gitkeep", - "docs/Makefile", - "docs/commands.rst", - "docs/conf.py", - "docs/getting-started.rst", - "docs/index.rst", - "docs/make.bat", + "docs/.gitkeep", "notebooks/.gitkeep", "references/.gitkeep", "reports/.gitkeep", @@ -117,6 +115,14 @@ def verify_files(root, config): f"{config['module_name']}/visualization/visualize.py", ] + if config["docs"] == "mkdocs": + expected_files += [ + "docs/mkdocs.yml", + "docs/README.md", + "docs/docs/index.md", + "docs/docs/getting-started.md", + ] + expected_files.append(config["dependency_file"]) expected_files = [Path(f) for f in expected_files] diff --git a/{{ cookiecutter.repo_name }}/.gitignore b/{{ cookiecutter.repo_name }}/.gitignore index a9b512356..a5df42ba5 100644 --- a/{{ cookiecutter.repo_name }}/.gitignore +++ b/{{ cookiecutter.repo_name }}/.gitignore @@ -80,8 +80,8 @@ instance/ # Scrapy stuff: .scrapy -# Sphinx documentation -docs/_build/ +# MkDocs documentation +docs/site/ # PyBuilder .pybuilder/ diff --git a/{{ cookiecutter.repo_name }}/README.md b/{{ cookiecutter.repo_name }}/README.md index a844c4f35..dae084285 100644 --- a/{{ cookiecutter.repo_name }}/README.md +++ b/{{ cookiecutter.repo_name }}/README.md @@ -14,7 +14,7 @@ │ ├── processed <- The final, canonical data sets for modeling. │ └── raw <- The original, immutable data dump. │ -├── docs <- A default Sphinx project; see sphinx-doc.org for details +├── docs <- A default mkdocs project; see mkdocs.org for details │ ├── models <- Trained and serialized models, model predictions, or model summaries │ diff --git a/{{ cookiecutter.repo_name }}/docs/.gitkeep b/{{ cookiecutter.repo_name }}/docs/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/{{ cookiecutter.repo_name }}/docs/Makefile b/{{ cookiecutter.repo_name }}/docs/Makefile deleted file mode 100644 index 7dab2b193..000000000 --- a/{{ cookiecutter.repo_name }}/docs/Makefile +++ /dev/null @@ -1,153 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -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 " singlehtml to make a single large HTML file" - @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 " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @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 $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/{{ cookiecutter.repo_name }}.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/{{ cookiecutter.repo_name }}.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/{{ cookiecutter.repo_name }}" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/{{ cookiecutter.repo_name }}" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/{{ cookiecutter.repo_name }}/docs/conf.py b/{{ cookiecutter.repo_name }}/docs/conf.py deleted file mode 100644 index 831fe3a90..000000000 --- a/{{ cookiecutter.repo_name }}/docs/conf.py +++ /dev/null @@ -1,244 +0,0 @@ -# -*- coding: utf-8 -*- -# -# {{ cookiecutter.project_name }} documentation build configuration file, created by -# sphinx-quickstart. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import os -import sys - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = {{ "%r"|format(cookiecutter.project_name) }} - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.1' -# The full version, including alpha/beta/rc tags. -release = '0.1' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = '{{ cookiecutter.repo_name }}doc' - - -# -- Options for LaTeX output -------------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # 'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', - '{{ cookiecutter.repo_name }}.tex', - {{ "%r"|format(cookiecutter.project_name) }}, ' Documentation', - {{ "%r"|format(cookiecutter.author_name) }}, 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', '{{ cookiecutter.repo_name }}', {{ "%r"|format(cookiecutter.project_name) }} + ' Documentation', - [{{ "%r"|format(cookiecutter.project_name) }}], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------------ - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', '{{ cookiecutter.repo_name }}', {{ "%r"|format(cookiecutter.project_name) }} + ' Documentation', - {{ "%r"|format(cookiecutter.author_name) }}, {{ "%r"|format(cookiecutter.project_name) }}, - {{ "%r"|format(cookiecutter.description) }}, 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' diff --git a/{{ cookiecutter.repo_name }}/docs/index.rst b/{{ cookiecutter.repo_name }}/docs/index.rst deleted file mode 100644 index 88e31e98b..000000000 --- a/{{ cookiecutter.repo_name }}/docs/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. {{ cookiecutter.project_name }} documentation master file, created by - sphinx-quickstart. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -{{ cookiecutter.project_name }} documentation! -============================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - getting-started - commands - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/{{ cookiecutter.repo_name }}/docs/make.bat b/{{ cookiecutter.repo_name }}/docs/make.bat deleted file mode 100644 index aa1d05a27..000000000 --- a/{{ cookiecutter.repo_name }}/docs/make.bat +++ /dev/null @@ -1,190 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -set I18NSPHINXOPTS=%SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :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. singlehtml to make a single large HTML file - 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. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over 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 - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\{{ cookiecutter.repo_name }}.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\{{ cookiecutter.repo_name }}.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -:end diff --git a/{{ cookiecutter.repo_name }}/docs/mkdocs/README.md b/{{ cookiecutter.repo_name }}/docs/mkdocs/README.md new file mode 100644 index 000000000..79c146859 --- /dev/null +++ b/{{ cookiecutter.repo_name }}/docs/mkdocs/README.md @@ -0,0 +1,12 @@ +Generating the docs +---------- + +Use [mkdocs](http://www.mkdocs.org/) structure to update the documentation. + +Build locally with: + + mkdocs build + +Serve locally with: + + mkdocs serve diff --git a/{{ cookiecutter.repo_name }}/docs/getting-started.rst b/{{ cookiecutter.repo_name }}/docs/mkdocs/docs/getting-started.md similarity index 100% rename from {{ cookiecutter.repo_name }}/docs/getting-started.rst rename to {{ cookiecutter.repo_name }}/docs/mkdocs/docs/getting-started.md diff --git a/{{ cookiecutter.repo_name }}/docs/commands.rst b/{{ cookiecutter.repo_name }}/docs/mkdocs/docs/index.md similarity index 84% rename from {{ cookiecutter.repo_name }}/docs/commands.rst rename to {{ cookiecutter.repo_name }}/docs/mkdocs/docs/index.md index 438a52ff4..fa6b7ed33 100644 --- a/{{ cookiecutter.repo_name }}/docs/commands.rst +++ b/{{ cookiecutter.repo_name }}/docs/mkdocs/docs/index.md @@ -1,11 +1,15 @@ -Commands -======== +# {{ cookiecutter.project_name }} documentation! +{% if cookiecutter.project_description is not none %} +## Description -The Makefile contains the central entry points for common tasks related to this project. +{{ cookiecutter.description}} +{% endif %} +## Commands +The Makefile contains the central entry points for common tasks related to this project. {% if not cookiecutter.dataset_storage.none %} -Syncing data to cloud storage -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Syncing data to cloud storage + {% if cookiecutter.dataset_storage.s3 -%} * `make sync_data_up` will use `aws s3 sync` to recursively sync files in `data/` up to `s3://{{ cookiecutter.dataset_storage.s3.bucket }}/data/`. * `make sync_data_down` will use `aws s3 sync` to recursively sync files from `s3://{{ cookiecutter.dataset_storage.s3.bucket }}/data/` to `data/`. @@ -16,4 +20,4 @@ Syncing data to cloud storage * `make sync_data_up` will use `gsutil rsync` to recursively sync files in `data/` up to `gs://{{ cookiecutter.dataset_storage.gcs.bucket }}/data/`. * `make sync_data_down` will use `gsutil rsync` to recursively sync files in `gs://{{ cookiecutter.dataset_storage.gcs.bucket }}/data/` to `data/`. {% endif %} -{% endif %} \ No newline at end of file +{% endif %} diff --git a/{{ cookiecutter.repo_name }}/docs/mkdocs/mkdocs.yml b/{{ cookiecutter.repo_name }}/docs/mkdocs/mkdocs.yml new file mode 100644 index 000000000..77aa94c1a --- /dev/null +++ b/{{ cookiecutter.repo_name }}/docs/mkdocs/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: {{ cookiecutter.project_name }} +# {% if cookiecutter.author_name %} +site_author: {{ cookiecutter.author_name }} +# {% endif %} \ No newline at end of file