diff options
author | Daniel Dunbar <daniel@zuster.org> | 2012-04-19 16:31:37 +0000 |
---|---|---|
committer | Daniel Dunbar <daniel@zuster.org> | 2012-04-19 16:31:37 +0000 |
commit | 21e993c1b1083ef91441a363997d0efc8e646191 (patch) | |
tree | 1c07b2ea2dd18b8219d46415cee365abc93578e2 /docs/conf.py | |
parent | 75083ebc09a3dd47099e3912ac090dbc907f3eaf (diff) |
[docs] Convert docs index page into Sphinx.
- Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation.
- Lots of styling, editing, and integration work yet to comeā¦
- PR12589
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155133 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/conf.py b/docs/conf.py index e44dfc0de6..324410ed56 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,7 +36,7 @@ source_suffix = '.rst' #source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'contents' +master_doc = 'index' # General information about the project. project = u'LLVM' @@ -134,7 +134,14 @@ html_sidebars = {'index': 'indexsidebar.html'} # Additional templates that should be rendered to pages, maps page names to # template names. -html_additional_pages = {'index': 'index.html'} +# +# We load all the old-school HTML documentation pages into Sphinx here. +basedir = os.path.dirname(__file__) +html_additional_pages = {} +for file in os.listdir(basedir): + if file.endswith('.html'): + name,_ = os.path.splitext(file) + html_additional_pages[name] = file # If false, no module index is generated. #html_domain_indices = True @@ -182,7 +189,7 @@ latex_elements = { # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('contents', 'LLVM.tex', u'LLVM Documentation', + ('index', 'LLVM.tex', u'LLVM Documentation', u'LLVM project', 'manual'), ] @@ -212,7 +219,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('contents', 'LLVM', u'LLVM Documentation', + ('index', 'LLVM', u'LLVM Documentation', [u'LLVM project'], 1) ] @@ -226,7 +233,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('contents', 'LLVM', u'LLVM Documentation', + ('index', 'LLVM', u'LLVM Documentation', u'LLVM project', 'LLVM', 'One line description of project.', 'Miscellaneous'), ] |