Skip to content

Commit

Permalink
Fix broken documentation links, turn warning into error
Browse files Browse the repository at this point in the history
  • Loading branch information
kraigher committed Apr 14, 2018
1 parent 25b7372 commit 9f1a038
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
def main():
create_release_notes()
check_call([sys.executable, "-m", "sphinx",
"-T", "-E", "-a", "-n", "-b", "html",
"-T", "-E", "-W", "-a", "-n", "-b", "html",
dirname(__file__), sys.argv[1]])

if __name__ == "__main__":
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -357,5 +357,6 @@
htmlhelp_basename = 'vunitdoc'

extlinks = {'vunit_example' : ('https://github.com/VUnit/vunit/tree/master/examples/%s/', ''),
'vunit_file' : ('https://github.com/VUnit/vunit/tree/master/%s/', ''),
'vunit_commit' : ('https://github.com/vunit/vunit/tree/%s/', '@'),
'vunit_issue' : ('https://github.com/VUnit/vunit/issues/%s/', '#')}
8 changes: 4 additions & 4 deletions docs/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,15 +203,15 @@ There are many examples demonstrating more specific usage of VUnit listed below:
can be used to handle dynamically sized 1D, 2D and 3D data as well
as storing and loading it from csv and raw files.

:vunit_example:`Array and AXI4 Stream Verification Components Example <vhdl/array>`
:vunit_example:`Array and AXI4 Stream Verification Components Example <vhdl/array_axis_vcs>`
Demonstrates ``array_t``, ``axi_stream_master_t`` and ``axi_stream_slave_t``
data types of ``array_pkg.vhd``, ``stream_master_pkg`` and ``stream_slave_pkg``,
respectively. Also, ``push_axi_stream`` of ``axi_stream_pkg`` is used. A CSV file
is read, the content is sent in a row-major order to an AXI Stream buffer (FIFO)
and it is received back to be saved in a different file. Further information can
be found in the :ref:`verification component library user guide <verification_components/user_guide>`,
in subsection :ref:`Stream <verification_components/vci/stream>` and in
:ref:`vhdl/verification_components/test/tb_axi_stream.vhd <../../vunit/vhdl/verification_components/test/tb_axi_stream.vhd>`.
be found in the :ref:`verification component library user guide <vc_library>`,
in subsection :ref:`Stream <stream_vci>` and in
:vunit_file:`vhdl/verification_components/test/tb_axi_stream.vhd <vunit/vhdl/verification_components/test/tb_axi_stream.vhd>`.

:vunit_example:`Generating tests <vhdl/generate_tests>`
Demonstrates generating multiple test runs of the same test bench
Expand Down
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ deps=
py27-unit: mock
lint: pep8
lint: pylint
docs: docutils==0.13.1
docs: sphinx==1.4.9
docs: docutils
docs: sphinx
docs: sphinx-argparse
docs: ablog

Expand Down

0 comments on commit 9f1a038

Please sign in to comment.