Skip to content

H
Hdlmake
Commit d7740ae8 authored by Javier D. Garcia-Lasheras's avatar Javier D. Garcia-Lasheras
Browse files
Options

Initial automated API docs generation

parent df706b2d
Hide whitespace changes
Inline Side-by-side
Showing with 36 additions and 3 deletions
docs/Makefile
View file @ d7740ae8
...@@ -50,6 +50,7 @@ clean: ...@@ -50,6 +50,7 @@ clean:
rm -rf $(BUILDDIR)/* rm -rf $(BUILDDIR)/*
html: html:
sphinx-apidoc -f -o . ../hdlmake
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo @echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
......
docs/conf.py
View file @ d7740ae8
...@@ -46,7 +46,7 @@ master_doc = 'index' ...@@ -46,7 +46,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'hdlmake' 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 # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
...@@ -119,7 +119,7 @@ html_theme = 'default' ...@@ -119,7 +119,7 @@ html_theme = 'default'
# The name of an image file (relative to this directory) to place at the top # The name of an image file (relative to this directory) to place at the top
# of the sidebar. # 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 # 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 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
...@@ -258,3 +258,7 @@ texinfo_documents = [ ...@@ -258,3 +258,7 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
# Path to sources
sys.path.insert(0, os.path.abspath('../hdlmake'))
docs/index.rst
View file @ d7740ae8
...@@ -54,5 +54,33 @@ http://www.ohwr.org/mailing_list/show?project_id=hdl-make ...@@ -54,5 +54,33 @@ http://www.ohwr.org/mailing_list/show?project_id=hdl-make
License License
------- -------
.. image:: images/by-sa.*
:align: center
:target: http://creativecommons.org/licenses/by-sa/4.0/deed.en_US
This document is licensed under the Creative Commons Attribution-ShareAlike 4.0
International License. To view a copy of this license, visit:
http://creativecommons.org/licenses/by-sa/4.0/deed.en_US
.. image:: images/GPLv3_logo.*
:align: center
:target: http://www.gnu.org/copyleft/gpl.html
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:
http://www.gnu.org/copyleft/gpl.html
Copyright notice
----------------
.. image:: images/CERN_logo.*
:scale: 50 %
:alt: CERN Logo
:align: center
:target: http://home.web.cern.ch/
`CERN
<http://home.web.cern.ch/>`_, 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