Skip to content

Commit

Permalink
apio and apio verify documentation: Moved to a wiki page
Browse files Browse the repository at this point in the history
  • Loading branch information
Obijuan committed Apr 1, 2024
1 parent 449fb33 commit ec93adc
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 133 deletions.
91 changes: 0 additions & 91 deletions docs/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,97 +30,6 @@ An Apio project consist of the following files:
- Optionally, a testbench file ending in ``_tb.v``. This file will be excluded by :ref:`cmd_build`,
but become the main module for :ref:`cmd_sim`.

Usage
-----

.. code-block:: bash
apio [OPTIONS] COMMAND [ARGS]
You can execute just `apio` to see the help:

.. code-block:: none
$ apio
Usage: apio [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--help Show this message and exit.
Project commands:
build Synthesize the bitstream.
clean Clean the previous generated files.
lint Lint the verilog code.
sim Launch the verilog simulation.
time Bitstream timing analysis.
upload Upload the bitstream to the FPGA.
verify Verify the verilog code.
Setup commands:
drivers Manage FPGA boards drivers.
init Manage apio projects.
install Install packages.
uninstall Uninstall packages.
Utility commands:
boards Manage FPGA boards.
config Apio configuration.
examples Manage verilog examples.
raw Execute commands using Apio packages.
system System tools.
upgrade Check the latest Apio version.
Options
-------

.. program:: apio

.. option::
--version

Show the version of Apio.

Project Commands
----------------

.. toctree::
:maxdepth: 1

project_commands/cmd_build
project_commands/cmd_clean
project_commands/cmd_graph
project_commands/cmd_lint
project_commands/cmd_sim
project_commands/cmd_test
project_commands/cmd_time
project_commands/cmd_upload
project_commands/cmd_verify

Setup Commands
--------------

.. toctree::
:maxdepth: 1

setup_commands/cmd_drivers
setup_commands/cmd_init
setup_commands/cmd_install
setup_commands/cmd_uninstall

Utility Commands
----------------

.. toctree::
:maxdepth: 1

util_commands/cmd_boards
util_commands/cmd_config
util_commands/cmd_examples
util_commands/cmd_raw
util_commands/cmd_system
util_commands/cmd_upgrade

.. _apio_ini:

Project Configuration File (apio.ini)
Expand Down
42 changes: 0 additions & 42 deletions docs/source/user_guide/project_commands/cmd_verify.rst

This file was deleted.

0 comments on commit ec93adc

Please sign in to comment.