Initial automated API docs generation

parent df706b2d
......@@ -50,6 +50,7 @@ clean:
rm -rf $(BUILDDIR)/*
sphinx-apidoc -f -o . ../hdlmake
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
......@@ -46,7 +46,7 @@ master_doc = 'index'
# General information about the project.
project = u'hdlmake'
copyright = u'2014, Pawel Szostek, Javier D. Garcia-Lasheras'
copyright = u'2014, CERN'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
......@@ -119,7 +119,7 @@ html_theme = 'default'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = 'images/ohr_logo.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
......@@ -258,3 +258,7 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# Path to sources
sys.path.insert(0, os.path.abspath('../hdlmake'))
......@@ -54,5 +54,33 @@
.. image:: images/by-sa.*
:align: center
This document is licensed under the Creative Commons Attribution-ShareAlike 4.0
International License. To view a copy of this license, visit:
.. image:: images/GPLv3_logo.*
:align: center
The source code for the hdlmake project is licensed under the GPL license version 3 or later.
To get more info about this license, visit the following link:
Copyright notice
.. image:: images/CERN_logo.*
:scale: 50 %
:alt: CERN Logo
:align: center
<>`_, the European Organization for Nuclear Research,
is the first and sole owner of all copyright of both this document and
the associated source code deliverables.
The project is licensed under the GPL v3 license.
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