Skip to content
Snippets Groups Projects
Commit 9cb32dde authored by auphelia's avatar auphelia
Browse files

[Sphinx documentation] First try of auto-generated documentation

parent e268dbe5
No related branches found
No related tags found
No related merge requests found
Showing
with 118 additions and 0 deletions
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d6225cd89c4ad632a889e6891851ac42
tags: 645f666f9bcd5a90fca523b33c5a78b7
.. FINN documentation master file, created by
sphinx-quickstart on Thu Feb 20 12:08:33 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to FINN's documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
src
===
.. toctree::
:maxdepth: 4
src
src.finn.analysis.fpgadataflow package
======================================
Submodules
----------
src.finn.analysis.fpgadataflow.hls\_synth\_res\_estimation module
-----------------------------------------------------------------
.. automodule:: src.finn.analysis.fpgadataflow.hls_synth_res_estimation
:members:
:undoc-members:
:show-inheritance:
src.finn.analysis.fpgadataflow.res\_estimation module
-----------------------------------------------------
.. automodule:: src.finn.analysis.fpgadataflow.res_estimation
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: src.finn.analysis.fpgadataflow
:members:
:undoc-members:
:show-inheritance:
src.finn.analysis package
=========================
Subpackages
-----------
.. toctree::
src.finn.analysis.fpgadataflow
Submodules
----------
src.finn.analysis.topology module
---------------------------------
.. automodule:: src.finn.analysis.topology
:members:
:undoc-members:
:show-inheritance:
src.finn.analysis.verify\_custom\_nodes module
----------------------------------------------
.. automodule:: src.finn.analysis.verify_custom_nodes
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: src.finn.analysis
:members:
:undoc-members:
:show-inheritance:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment