| index : archinstall32 | |
| Archlinux32 installer | gitolite user |
| summaryrefslogtreecommitdiff |
| -rw-r--r-- | docs/conf.py | 24 | ||||
| -rw-r--r-- | docs/pull_request_template.md | 4 |
diff --git a/docs/conf.py b/docs/conf.py index 326b2d69..9d23f979 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,7 @@ import os import re import sys + sys.path.insert(0, os.path.abspath('..')) @@ -11,9 +12,11 @@ def process_docstring(app, what, name, obj, options, lines): ll.append(spaces_pat.sub(" ", l)) lines[:] = ll + def setup(app): app.connect('autodoc-process-docstring', process_docstring) + # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full @@ -40,7 +43,6 @@ author = 'Anton Hvornum' # The full version, including alpha/beta/rc tags release = 'v2.1.0' - # -- General configuration --------------------------------------------------- master_doc = 'index' @@ -61,13 +63,12 @@ templates_path = ['_templates'] # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - # -- 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' +# html_theme = 'alabaster' html_theme = 'sphinx_rtd_theme' html_logo = "_static/logo.png" @@ -90,18 +91,18 @@ html_split_index = True html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a <link> tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'archinstalldoc' @@ -110,15 +111,10 @@ htmlhelp_basename = 'archinstalldoc' # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - ( - "index", "archinstall", u"archinstall Documentation", - [u"Anton Hvornum"], 1 - ) -] +man_pages = [("index", "archinstall", u"archinstall Documentation", [u"Anton Hvornum"], 1)] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 729c1aae..18d01ab2 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -12,5 +12,5 @@ If the PR is larger than ~20 lines, please describe it here unless described in # Testing -Any new feature or stability improvement should be tested if possible. -Please follow the test instructions at the bottom of the README or use the ISO built on each PR.
\ No newline at end of file +Any new feature or stability improvement should be tested if possible. Please follow the test instructions at the bottom +of the README or use the ISO built on each PR. |