clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-10-03 15:39:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding componentized index files (per category) for proper navigation with new CSS.

Browse Source
This commit is contained in:
Tullis, Michael L
2015-11-25 08:23:42 -07:00
parent e386a14cff
commit 74672780ba
6 changed files with 108 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/conf.py
+41 -24
View File
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
#
# ClearLinux Documentation documentation build configuration file, created by
# sphinx-quickstart on Fri Nov 13 12:23:35 2015.
# Clear Linux documentation build configuration file, created by
# sphinx-quickstart on Fri May 8 11:43:01 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
@@ -29,7 +29,13 @@ import shlex
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
#extensions = [
# 'sphinx.ext.autodoc', 'breathe', 'sphinx.ext.todo'
#]
extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.todo'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -46,18 +52,18 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'ClearLinux Documentation'
copyright = u'2015, Intel OTC'
author = u'Intel OTC'
project = u'Clear Linux* Project for Intel® Architecture'
copyright = u'2015, many'
author = u'many'
# 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 = '1.0.1'
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '1.0.1'
release = '0.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -103,12 +109,16 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
rst_epilog = """
.. include:: /substitutions.rst
"""
# -- 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 = 'clearlinux'
#html_theme = 'zephyr'
# 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
@@ -116,11 +126,11 @@ html_theme = 'alabaster'
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
html_theme_path = ['./_themes']
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
html_title = "Documentation for Clear Linux* Project for Intel(r) Architecture"
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
@@ -146,11 +156,11 @@ 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'
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
#html_use_smartypants =
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
@@ -160,22 +170,22 @@ html_static_path = ['_static']
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
html_domain_indices = False
# If false, no index is generated.
#html_use_index = True
html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
html_split_index = True
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
#html_show_sourcelink =
# 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
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
@@ -200,7 +210,7 @@ html_static_path = ['_static']
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'ClearLinuxDocumentationdoc'
htmlhelp_basename = 'clrdoc'
# -- Options for LaTeX output ---------------------------------------------
@@ -222,8 +232,8 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'ClearLinuxDocumentation.tex', u'ClearLinux Documentation Documentation',
u'Intel OTC', 'manual'),
(master_doc, 'clr.tex', u'Documentation for Clear Linux* Project for Intel® Architecture',
u'many', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -252,7 +262,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'clearlinuxdocumentation', u'ClearLinux Documentation Documentation',
(master_doc, 'clearlinux', u'Documentation for Clear Linux* Project for Intel® Architecture',
[author], 1)
]
@@ -266,8 +276,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'ClearLinuxDocumentation', u'ClearLinux Documentation Documentation',
author, 'ClearLinuxDocumentation', 'One line description of project.',
(master_doc, 'clearlinux', u'Documentation for Clear Linux* Project for Intel® Architecture',
author, 'Clear Linux', 'One line description of project.',
'Miscellaneous'),
]
@@ -282,3 +292,10 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
#breathe_projects = {
# "Zephyr": "xml",
# "doc-examples": "xml"
#}
#breathe_default_project = "Zephyr"
html_add_permalinks = False
source/index-openstack.rst
+21
View File
@@ -0,0 +1,21 @@
OpenStack* implementation
#########################
.. toctree::
:maxdepth: 1
openstack_use_cases
openstack_bundle_and_service_summary
openstack_sys_req_and_pw_summary
openstack_installing_bundles
openstack_supporting-database
openstack_supporting-messaging
openstack_identity
openstack_identity-openrc
openstack_image
openstack_compute
openstack_block_storage
openstack_dashboard
openstack_networking
openstack_orchestration
openstack_telemetry
source/index.rst
+17 -42
View File
@@ -4,79 +4,54 @@
contain the root `toctree` directive.
Clear Linux* Project for Intel® Architecture--Documentation
===========================================================
############################################################
Getting started
================
.. toctree::
:maxdepth: 2
Getting started
###############
.. toctree::
:maxdepth: 1
gs_getting_started
gs_supported_hardware
gs_creating_bootable_usb
gs_installing_clr_as_host
gs_running_clr_virtual
gs-clear-containers-gettting-started
index_gs.rst
Software update
###############
===============
.. toctree::
:maxdepth: 1
:maxdepth: 2
swupdate_about_sw_update
swupdate_how_to_run_the_updater
index_sw_update.rst
Bundles
#######
=======
.. toctree::
:maxdepth: 1
:maxdepth: 2
bundles_overview
bundles_in_clr
table_view_bundles
index_bundles.rst
OpenStack* implementation
#############################
=========================
.. toctree::
:maxdepth: 1
:maxdepth: 2
openstack_use_cases
openstack_bundle_and_service_summary
openstack_sys_req_and_pw_summary
openstack_installing_bundles
openstack_supporting-database
openstack_supporting-messaging
openstack_identity
openstack_identity-openrc
openstack_image
openstack_compute
openstack_block_storage
openstack_dashboard
openstack_networking
openstack_orchestration
openstack_telemetry
index-openstack.rst
Indices and tables
==================
##################
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
License and Disclaimers
=======================
#######################
.. toctree::
.. include:: documentation_license.rst
source/index_bundles.rst
+9
View File
@@ -0,0 +1,9 @@
Bundles
#######
.. toctree::
:maxdepth: 2
bundles_overview
bundles_in_clr
table_view_bundles
source/index_gs.rst
+12
View File
@@ -0,0 +1,12 @@
Getting started
###############
.. toctree::
:maxdepth: 2
gs_getting_started
gs_supported_hardware
gs_creating_bootable_usb
gs_installing_clr_as_host
gs_running_clr_virtual
gs-clear-containers-gettting-started
source/index_sw_update.rst
+8
View File
@@ -0,0 +1,8 @@
Software update
###############
.. toctree::
:maxdepth: 2
swupdate_about_sw_update
swupdate_how_to_run_the_updater