Commit fbe92917 authored by Lukas Jelonek's avatar Lukas Jelonek
Browse files

Refactor documentation to remove source directory

parent d64ebcc6
......@@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = DBXRefresolveandretrievaltool
SPHINXPROJ = dbxref
SOURCEDIR = .
BUILDDIR = _build
......
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# DBXRef resolve and retrieval tool documentation build configuration file, created by
# sphinx-quickstart on Wed Aug 2 11:31:57 2017.
# dbxref documentation build configuration file, created by
# sphinx-quickstart on Wed Jan 17 15:36:15 2018.
#
# This file is execfile()d with the current directory set to its
# containing dir.
......@@ -31,8 +31,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.todo']
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -48,7 +47,7 @@ master_doc = 'index'
# General information about the project.
project = 'DBXRef resolve and retrieval tool'
copyright = '2017, Lukas Jelonek'
copyright = '2018, Lukas Jelonek'
author = 'Lukas Jelonek'
# The version info for the project you're documenting, acts as replacement for
......@@ -56,9 +55,9 @@ author = 'Lukas Jelonek'
# built documents.
#
# The short X.Y version.
version = '0.1'
version = '0.1.0'
# The full version, including alpha/beta/rc tags.
release = '0.1'
release = '0.1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -97,11 +96,26 @@ html_theme = 'sphinx_rtd_theme'
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
'donate.html',
]
}
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'DBXRefresolveandretrievaltooldoc'
htmlhelp_basename = 'dbxrefdoc'
# -- Options for LaTeX output ---------------------------------------------
......@@ -128,7 +142,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'DBXRefresolveandretrievaltool.tex', 'DBXRef resolve and retrieval tool Documentation',
(master_doc, 'dbxref.tex', 'dbxref Documentation',
'Lukas Jelonek', 'manual'),
]
......@@ -138,7 +152,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'dbxrefresolveandretrievaltool', 'DBXRef resolve and retrieval tool Documentation',
(master_doc, 'dbxref', 'dbxref Documentation',
[author], 1)
]
......@@ -149,8 +163,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'DBXRefresolveandretrievaltool', 'DBXRef resolve and retrieval tool Documentation',
author, 'DBXRefresolveandretrievaltool', 'One line description of project.',
(master_doc, 'dbxref', 'dbxref Documentation',
author, 'dbxref', 'One line description of project.',
'Miscellaneous'),
]
......
......@@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=DBXRefresolveandretrievaltool
set SPHINXPROJ=dbxref
if "%1" == "" goto help
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment