Skip to content

Commit

Permalink
Merge pull request #65 from casper-astro/casper-astro-soak-test-ska
Browse files Browse the repository at this point in the history
Casper astro soak test ska
  • Loading branch information
amishatishpatel committed Aug 15, 2018
2 parents 765b7b9 + e525085 commit b776536
Show file tree
Hide file tree
Showing 25 changed files with 567 additions and 579 deletions.
20 changes: 6 additions & 14 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,18 @@
import sys
from sphinx.apidoc import main as sphinx_apidoc_main
# add jasper_library directory to sys.path so autodoc can document its modules.
jasper_library_path = os.path.abspath(os.path.join(os.path.dirname(os.path.dirname(__file__)), 'jasper_library'))
jasper_library_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'jasper_library'))
sys.path.insert(0, jasper_library_path)
# use sphinx-apidoc to automatically document modules, classes, functions, etc.
# Code found here: https://github.com/rtfd/readthedocs.org/issues/1139
def run_apidoc(_):
build_modules_dir = os.path.join(os.path.dirname(__file__), 'src', 'jasper_library_modules')
ignore_file = 'conf.py'
sphinx_apidoc_main(['-e', '-o', build_modules_dir, jasper_library_path, ignore_file, '--force'])

# Workaround to include __init__'s with sphinx-apidoc generated documnentation.
# Code found here: https://stackoverflow.com/questions/5599254/how-to-use-sphinxs-autodoc-to-document-a-classs-init-self-method
def skip(app, what, name, obj, skip, options):
if name == "__init__":
return False
return skip

def setup(app):
app.connect('builder-inited', run_apidoc)
app.connect("autodoc-skip-member", skip)


# -- Project information -----------------------------------------------------

project = 'CASPER Toolflow'
Expand Down Expand Up @@ -65,8 +58,7 @@ def setup(app):
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinx_markdown_tables',
'sphinx.ext.githubpages'
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -198,9 +190,9 @@ def setup(app):
# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
intersphinx_mapping = {'casperfpga': ('https://casper-toolflow.readthedocs.io/projects/casperfpga/en/latest/', None)}

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
todo_include_todos = True
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ Documentation
* :doc:`Block Documentation <blockdocumentation>`
* :doc:`Toolflow Documentation <jasper_documentation>`
* :doc:`Toolflow Sourcecode <src/jasper_library_modules/modules>`
* `casperfpga Sourcecode <https://casper-toolflow.readthedocs.io/projects/casperfpga/en/latest/>`__

.. toctree::
:hidden:
Expand All @@ -107,3 +108,4 @@ Documentation
blockdocumentation
jasper_documentation
Toolflow Sourcecode <src/jasper_library_modules/modules>
casperfpga Sourcecode <https://casper-toolflow.readthedocs.io/projects/casperfpga/en/latest/>
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
markdown
sphinx
sphinx_rtd_theme
recommonmark
sphinx-markdown-tables
PyYAML
numpy
6 changes: 3 additions & 3 deletions docs/src/blockdocs/Fft_biplex_real_2x.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ Mask Parameters
| Input bit width | input\_bit\_width | The number of bits | To make optimal |
| | | in each real and | use of BRAMs => |
| | | imaginary sample | 18 |
| | | as they are input | | For low FFT |
| | | to the FFT. If bit | noise => |
| | | growth is not | | 25 |
| | | as they are input | For low FFT |
| | | to the FFT. If bit | noise => 25 |
| | | growth is not | |
| | | chosen, each FFT | |
| | | stage will round | |
| | | numbers back down | |
Expand Down
6 changes: 3 additions & 3 deletions docs/src/blockdocs/Fft_biplex_real_4x.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ Mask Parameters
| Input bit width | input\_bit\_width | The number of bits | To make optimal |
| | | in each real and | use of BRAMs => |
| | | imaginary sample | 18 |
| | | as they are input | | For low FFT |
| | | to the FFT. If bit | noise => |
| | | growth is not | | 25 |
| | | as they are input | For low FFT |
| | | to the FFT. If bit | noise => 25 |
| | | growth is not | |
| | | chosen, each FFT | |
| | | stage will round | |
| | | numbers back down | |
Expand Down
7 changes: 3 additions & 4 deletions docs/src/jasper_library_modules/castro.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
castro module
=============
castro
=======

.. automodule:: castro
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
7 changes: 0 additions & 7 deletions docs/src/jasper_library_modules/clk_factors.rst

This file was deleted.

7 changes: 3 additions & 4 deletions docs/src/jasper_library_modules/constraints.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
constraints module
==================
constraints
===========

.. automodule:: constraints
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
7 changes: 3 additions & 4 deletions docs/src/jasper_library_modules/exec_flow.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
exec\_flow module
=================
exec\_flow
===========

.. automodule:: exec_flow
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
7 changes: 3 additions & 4 deletions docs/src/jasper_library_modules/helpers.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
helpers module
==============
helpers
========

.. automodule:: helpers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
7 changes: 3 additions & 4 deletions docs/src/jasper_library_modules/memory.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
memory module
=============
memory
=======

.. automodule:: memory
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
3 changes: 1 addition & 2 deletions docs/src/jasper_library_modules/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,11 @@ jasper_library
:maxdepth: 4

castro
clk_factors
constraints
exec_flow
helpers
memory
platform
toolflow
verilog
yellow_blocks
yellow_blocks
9 changes: 4 additions & 5 deletions docs/src/jasper_library_modules/platform.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
platform module
===============
platform
=========

.. automodule:: platform
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
7 changes: 3 additions & 4 deletions docs/src/jasper_library_modules/toolflow.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
toolflow module
===============
toolflow
=========

.. automodule:: toolflow
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
7 changes: 3 additions & 4 deletions docs/src/jasper_library_modules/verilog.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
verilog module
==============
verilog
========

.. automodule:: verilog
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

0 comments on commit b776536

Please sign in to comment.