diff options
| -rw-r--r-- | doc/Makefile | 22 | ||||
| -rw-r--r-- | doc/README.md | 41 | ||||
| -rw-r--r-- | doc/sphinx/conf.py | 184 | ||||
| -rw-r--r-- | doc/sphinx/index.rst | 24 | ||||
| -rw-r--r-- | doc/sphinx/userguide.rst | 8 | ||||
| -rw-r--r-- | doc/sphinx/userguide/installing.rst | 4 |
6 files changed, 283 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..972a080 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,22 @@ +# Copyright (c) 2019 SiFive Inc. +# +# Documentation Build + +.PHONY: all +all: html + +########################### +# Build HTML Documentation +########################### + +.PHONY: html +html: html/index.html + +# Use Sphinx to build HTML from Doxygen XML +html/index.html: sphinx/* + sphinx-build -b html sphinx html + +.PHONY: clean +clean: + rm -rf html + diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..9fd78df --- /dev/null +++ b/doc/README.md @@ -0,0 +1,41 @@ +# Documentation Generation + +## Requirements + +You'll need the following software: +- [Sphinx](http://www.sphinx-doc.org/en/master/index.html) + +### Ubuntu + +You can install the required software on Ubuntu with the following: + +``` +sudo apt install python3-sphinx +``` + +The second line can be omitted if you don't intend to build the PDF. + +### MacOS + +You can install the required software on MacOS with the following: + +``` +brew install sphinx-doc +``` + +The second line can be omitted if you don't intend to build the PDF. + +## Building the Docs + +You can generate the HTML documentation with +``` +make +``` + +You can clean the build files and outputs with + +``` +make clean +``` + + diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py new file mode 100644 index 0000000..d41a8a8 --- /dev/null +++ b/doc/sphinx/conf.py @@ -0,0 +1,184 @@ +# -*- 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. +# +import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'Freedom E SDK' +copyright = '2019, SiFive Inc.' +author = 'SiFive Inc.' + +# The short X.Y version +version = os.popen("git describe").read().strip() +# The full version, including alpha/beta/rc tags +release = version + + +# -- 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 = [ + 'sphinx.ext.intersphinx', + 'sphinx.ext.githubpages', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['esdktemplates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# 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 = None + +# 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 = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- 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 = ['esdkstatic'] + +# 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 = {} +html_sidebars = { '**': ['about.html', 'navigation.html', 'relations.html', 'searchbox.html']} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'FreedomESDKdoc' + + +# -- 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, 'FreedomESDK.tex', 'Freedom E SDK Documentation', + 'SiFive Inc.', '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, 'freedomesdk', 'Freedom E SDK Documentation', + [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, 'FreedomESDK', 'Freedom E SDK Documentation', + author, 'FreedomESDK', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# 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'] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'metal' : ('https://sifive.github.io/freedom-metal-docs', None) } diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst new file mode 100644 index 0000000..e680a68 --- /dev/null +++ b/doc/sphinx/index.rst @@ -0,0 +1,24 @@ +Freedom E SDK +============= + +This is the documentatino for the SiFive Freedom E SDK |version|. + +Freedom E SDK is generally available from the `Freedom E SDK Repository`_. + +.. _Freedom E SDK Repository: + https://github.com/sifive/freedom-e-sdk + +Table of Contents +----------------- + +.. toctree:: + :maxdepth: 2 + + userguide + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`search` diff --git a/doc/sphinx/userguide.rst b/doc/sphinx/userguide.rst new file mode 100644 index 0000000..f0ad5db --- /dev/null +++ b/doc/sphinx/userguide.rst @@ -0,0 +1,8 @@ +User Guide +========== + +.. toctree:: + :maxdepth: 1 + :glob: + + userguide/* diff --git a/doc/sphinx/userguide/installing.rst b/doc/sphinx/userguide/installing.rst new file mode 100644 index 0000000..8684923 --- /dev/null +++ b/doc/sphinx/userguide/installing.rst @@ -0,0 +1,4 @@ +Installing Freedom E SDK +======================== + +Foo |