From 456361260732515f81a1572db0bcc7b38bb45d36 Mon Sep 17 00:00:00 2001 From: John Vandenberg Date: Wed, 30 May 2018 05:43:23 +0700 Subject: [PATCH] :sparkles: use upstream sphinx templates --- .travis.yml | 10 ++ config/data.yml | 4 + local.yml | 6 + templates/conf.py.jj2 | 68 ++++----- templates/docs/Makefile.jj2 | 19 +++ templates/docs/conf.py_t | 209 ++++++++++++++++++++++++++++ templates/docs/index.rst.jj2 | 13 ++ templates/docs/make.bat.jj2 | 36 +++++ templates/docs/master_doc.rst_t | 21 +++ templates/docs/source/conf.py.jj2 | 52 +------ templates/docs/source/index.rst.jj2 | 6 + 11 files changed, 359 insertions(+), 85 deletions(-) create mode 100644 templates/docs/Makefile.jj2 create mode 100644 templates/docs/conf.py_t create mode 100644 templates/docs/index.rst.jj2 create mode 100644 templates/docs/make.bat.jj2 create mode 100644 templates/docs/master_doc.rst_t create mode 100644 templates/docs/source/index.rst.jj2 diff --git a/.travis.yml b/.travis.yml index 69f03b9..a39c0a6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,6 +7,7 @@ notifications: email: false install: - pip install -r test_requirements.txt + stages: - test - moban @@ -19,6 +20,15 @@ jobs: - git diff --exit-code stage: test + +before_script: + - git clone https://github.com/sphinx-doc/sphinx ../sphinx + - (cd .. && ln -s sphinx/sphinx/templates/quickstart/ + sphinx-quickstart-templates) + - sed -i "s/{{ language | repr }}/'{{ language }}'/" + -i "s/{%- for/{% for/;s/{%- endfor/{% endfor/" + ../sphinx-quickstart-templates/conf.py_t + script: - find templates/ -type f -name '*.jj2' -exec echo '{}' \;|sed -e "s/templates\//{%include \"/" -e "s/$/\" %}/" > test.file - moban -c config/data.yml -t test.file -td templates . diff --git a/config/data.yml b/config/data.yml index e0ea3b7..4f4b0a3 100644 --- a/config/data.yml +++ b/config/data.yml @@ -12,3 +12,7 @@ description: Scaffolding templates for your Python project. release: 0.0.0 gitter_room: chfw_moban/Lobby setup_py: false +rsrcdir: docs/source +rbuilddir: docs/_build +version: 0.1.1rc3 +mastertocmaxdepth: 3 diff --git a/local.yml b/local.yml index 70d0431..9093a7e 100644 --- a/local.yml +++ b/local.yml @@ -3,7 +3,13 @@ configuration: template_dir: - .moban.dt/ - templates + - ../sphinx-quickstart-templates targets: - .gitignore: gitignore.jj2 - LICENSE: NEW_BSD_LICENSE.jj2 - README.rst: local-README.rst.jj2 +copy: + - templates/docs/Makefile.jj2: Makefile.new_t + - templates/docs/make.bat.jj2: make.bat.new_t + - templates/docs/master_doc.rst_t: master_doc.rst_t + - templates/docs/conf.py_t: conf.py_t diff --git a/templates/conf.py.jj2 b/templates/conf.py.jj2 index ca4a6a4..7860aee 100644 --- a/templates/conf.py.jj2 +++ b/templates/conf.py.jj2 @@ -7,44 +7,40 @@ DESCRIPTION = ( {% endfor %} '' ) -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.viewcode', -{%block SPHINX_EXTENSIONS%} -{%endblock%} -] -intersphinx_mapping = { -{%block intersphinx_mapping%} -{%endblock%} -} -templates_path = ['_templates'] -source_suffix = '.rst' -master_doc = 'index' +{% set project_str = name %} +{% set copyright_str = '{0} {1}'.format(copyright_year, company) %} +{% set author_str = author %} +{% set author = company %} +{% set version_str = release %} +{% set release_str = version %} +{% if sphinx_extensions %} +{% set extensions = sphinx_extensions %} +{% else %} +{% set extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode'] %} +{% endif %} +{% set project_fn = name %} +{% set dot = '_' %} +{% set suffix = '.rst' %} +{% set master_str = 'index' %} +{% set language = 'en' %} +{% set project_doc_str = name + ' Documentation' %} +{# TeX config #} +{% set project_doc_texescaped_str = project_doc_str %} +{% set author_texescaped_str = author %} +{# Man config #} +{% set project_manpage = name %} +{% include 'docs/conf.py_t' %} -project = u'{{name}}' -copyright = u'{{copyright_year}} {{company}}' -version = '{{release}}' -release = '{{version}}' -exclude_patterns = [] -pygments_style = 'sphinx' +# TODO: html_theme not configurable upstream {%block custom_doc_theme%} +{% if sphinx_html_theme %} +html_theme = '{{ sphinx_html_theme }}' +{% else %} html_theme = 'default' +{% endif %} {%endblock%} -html_static_path = ['_static'] -htmlhelp_basename = '{{name}}doc' -latex_elements = {} -latex_documents = [ - ('index', '{{name}}.tex', - '{{name}} Documentation', - '{{company}}', 'manual'), -] -man_pages = [ - ('index', '{{name}}', - '{{name}} Documentation', - [u'{{company}}'], 1) -] + +# TODO: DESCRIPTION not configurable upstream texinfo_documents = [ ('index', '{{name}}', '{{name}} Documentation', @@ -52,3 +48,7 @@ texinfo_documents = [ DESCRIPTION, 'Miscellaneous'), ] +intersphinx_mapping.update({ +{% block intersphinx_mapping %} +{% endblock %} +}) diff --git a/templates/docs/Makefile.jj2 b/templates/docs/Makefile.jj2 new file mode 100644 index 0000000..16a9d48 --- /dev/null +++ b/templates/docs/Makefile.jj2 @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = {{ rsrcdir }} +BUILDDIR = {{ rbuilddir }} + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/templates/docs/conf.py_t b/templates/docs/conf.py_t new file mode 100644 index 0000000..b16fd08 --- /dev/null +++ b/templates/docs/conf.py_t @@ -0,0 +1,209 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# 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. +# +{% if append_syspath -%} +import os +import sys +sys.path.insert(0, u'{{ module_path }}') +{% else -%} +# import os +# import sys +{% if module_path -%} +# sys.path.insert(0, u'{{ module_path }}') +{% else -%} +# sys.path.insert(0, os.path.abspath('.')) +{% endif -%} +{% endif %} + +# -- Project information ----------------------------------------------------- + +project = u'{{ project_str }}' +copyright = u'{{ copyright_str }}' +author = u'{{ author_str }}' + +# The short X.Y version +version = u'{{ version_str }}' +# The full version, including alpha/beta/rc tags +release = u'{{ release_str }}' + + +# -- 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 = [ +{% for ext in extensions %} + '{{ ext }}', +{% endfor %} +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['{{ dot }}templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '{{ suffix }}' + +# The master toctree document. +master_doc = '{{ master_str }}' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = '{{ language }}' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [{{ exclude_patterns }}] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# -- 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 = 'alabaster' + +# 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 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 = ['{{ dot }}static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = '{{ project_fn }}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': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, '{{ project_fn }}.tex', u'{{ project_doc_texescaped_str }}', + u'{{ author_texescaped_str }}', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, '{{ project_manpage }}', u'{{ project_doc_str }}', + [author], 1) +] + + +# -- 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 = [ + (master_doc, '{{ project_fn }}', u'{{ project_doc_str }}', + author, '{{ project_fn }}', 'One line description of project.', + 'Miscellaneous'), +] +{%- if epub %} + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] +{%- endif %} +{%- if extensions %} + + +# -- Extension configuration ------------------------------------------------- +{%- endif %} +{%- if 'sphinx.ext.intersphinx' in extensions %} + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} +{%- endif %} +{%- if 'sphinx.ext.todo' in extensions %} + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True +{%- endif %} diff --git a/templates/docs/index.rst.jj2 b/templates/docs/index.rst.jj2 new file mode 100644 index 0000000..88a9c75 --- /dev/null +++ b/templates/docs/index.rst.jj2 @@ -0,0 +1,13 @@ +{% macro underlines(name) %} +{%- for i in range(name|length) -%}={%- endfor -%} +{% endmacro %} +{% set project = name %} +{% set project_underline = underlines(name) %} +{% set mastertoctree = ' + .. toctree:: + :caption: API Documentation + :hidden: + + List of Modules +' %} +{% include "docs/master_doc.rst_t" %} diff --git a/templates/docs/make.bat.jj2 b/templates/docs/make.bat.jj2 new file mode 100644 index 0000000..50a12e7 --- /dev/null +++ b/templates/docs/make.bat.jj2 @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR={{ rsrcdir }} +set BUILDDIR={{ rbuilddir }} + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd + diff --git a/templates/docs/master_doc.rst_t b/templates/docs/master_doc.rst_t new file mode 100644 index 0000000..3aa98af --- /dev/null +++ b/templates/docs/master_doc.rst_t @@ -0,0 +1,21 @@ +.. {{ project }} documentation master file, created by + sphinx-quickstart on {{ now }}. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to {{ project }}'s documentation! +==========={{ project_underline }}================= + +.. toctree:: + :maxdepth: {{ mastertocmaxdepth }} + :caption: Contents: + +{{ mastertoctree }} + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/templates/docs/source/conf.py.jj2 b/templates/docs/source/conf.py.jj2 index ecb9725..94d8637 100644 --- a/templates/docs/source/conf.py.jj2 +++ b/templates/docs/source/conf.py.jj2 @@ -1,51 +1 @@ -# -*- coding: utf-8 -*- -{%block additional_imports%} -{%endblock%} -DESCRIPTION = ( -{% for i in range(0, description|length, 70) %} - '{{ description[i:(70+i)] }}' + -{% endfor %} - '' -) -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.viewcode', -{%block SPHINX_EXTENSIONS%} -{%endblock%} -] - -templates_path = ['_templates'] -source_suffix = '.rst' -master_doc = 'index' - -project = u'{{name}}' -copyright = u'{{copyright_year}} {{company}}' -version = '{{release}}' -release = '{{version}}' -exclude_patterns = [] -pygments_style = 'sphinx' -{%block custom_doc_theme%} -html_theme = 'default' -{%endblock%} -html_static_path = ['_static'] -htmlhelp_basename = '{{name}}doc' -latex_elements = {} -latex_documents = [ - ('index', '{{name}}.tex', - '{{name}} Documentation', - '{{company}}', 'manual'), -] -man_pages = [ - ('index', '{{name}}', - '{{name}} Documentation', - [u'{{company}}'], 1) -] -texinfo_documents = [ - ('index', '{{name}}', - '{{name}} Documentation', - '{{company}}', '{{name}}', - DESCRIPTION, - 'Miscellaneous'), -] +{% include 'conf.py.jj2' %} diff --git a/templates/docs/source/index.rst.jj2 b/templates/docs/source/index.rst.jj2 new file mode 100644 index 0000000..c00258a --- /dev/null +++ b/templates/docs/source/index.rst.jj2 @@ -0,0 +1,6 @@ +{% macro underlines(name) %} +{%- for i in range(name|length) -%}={%- endfor -%} +{% endmacro %} +{% set project = name %} +{% set project_underline = underlines(name) %} +{% include "docs/master_doc.rst_t" %}