parent
f1153352c0
commit
1fbd7f1d08
9
docs/_static/custom.css
vendored
9
docs/_static/custom.css
vendored
|
@ -3,12 +3,3 @@
|
||||||
|
|
||||||
/* Many of our diagnostics are even longer */
|
/* Many of our diagnostics are even longer */
|
||||||
.rst-content pre.literal-block, .rst-content div[class^="highlight"] pre, .rst-content .linenodiv pre { white-space: pre-wrap; }
|
.rst-content pre.literal-block, .rst-content div[class^="highlight"] pre, .rst-content .linenodiv pre { white-space: pre-wrap; }
|
||||||
|
|
||||||
/* Override what contentui does to body style */
|
|
||||||
.wy-nav-content { max-width: 800px !important; }
|
|
||||||
|
|
||||||
/* Make rubrics work like h3 */
|
|
||||||
.rst-content p.rubric {
|
|
||||||
font-size: 125%;
|
|
||||||
font-family: Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;
|
|
||||||
}
|
|
||||||
|
|
|
@ -12,8 +12,8 @@ extensions = [
|
||||||
"sphinx.ext.intersphinx",
|
"sphinx.ext.intersphinx",
|
||||||
"sphinx.ext.doctest",
|
"sphinx.ext.doctest",
|
||||||
"sphinx.ext.todo",
|
"sphinx.ext.todo",
|
||||||
"sphinxcontrib.contentui",
|
|
||||||
"sphinx_rtd_theme",
|
"sphinx_rtd_theme",
|
||||||
|
"sphinxcontrib.platformpicker",
|
||||||
]
|
]
|
||||||
|
|
||||||
with open(".gitignore") as f:
|
with open(".gitignore") as f:
|
||||||
|
|
|
@ -28,9 +28,9 @@ Installing prerequisites
|
||||||
|
|
||||||
.. |builtin-yosys-architectures| replace:: x86_64 and AArch64
|
.. |builtin-yosys-architectures| replace:: x86_64 and AArch64
|
||||||
|
|
||||||
.. content-tabs::
|
.. platform-picker::
|
||||||
|
|
||||||
.. tab-container:: windows
|
.. platform-choice:: windows
|
||||||
:title: Windows
|
:title: Windows
|
||||||
|
|
||||||
:ref:`Install Python <python:using-on-windows>`, either from Windows Store or using the full installer. If using the full installer, make sure to install a 64-bit version of Python.
|
:ref:`Install Python <python:using-on-windows>`, either from Windows Store or using the full installer. If using the full installer, make sure to install a 64-bit version of Python.
|
||||||
|
@ -39,7 +39,7 @@ Installing prerequisites
|
||||||
|
|
||||||
.. _Download GTKWave: https://sourceforge.net/projects/gtkwave/files/
|
.. _Download GTKWave: https://sourceforge.net/projects/gtkwave/files/
|
||||||
|
|
||||||
.. tab-container:: macos
|
.. platform-choice:: macos
|
||||||
:title: macOS
|
:title: macOS
|
||||||
|
|
||||||
Install Homebrew_. Then, install Python and GTKWave by running:
|
Install Homebrew_. Then, install Python and GTKWave by running:
|
||||||
|
@ -50,10 +50,9 @@ Installing prerequisites
|
||||||
|
|
||||||
.. _Homebrew: https://brew.sh
|
.. _Homebrew: https://brew.sh
|
||||||
|
|
||||||
.. tab-container:: linux
|
.. platform-choice:: debian
|
||||||
:title: Linux
|
:altname: linux
|
||||||
|
:title: Debian
|
||||||
.. rubric:: Debian-based distributions
|
|
||||||
|
|
||||||
Install Python and GTKWave by running:
|
Install Python and GTKWave by running:
|
||||||
|
|
||||||
|
@ -69,7 +68,8 @@ Installing prerequisites
|
||||||
|
|
||||||
If Yosys 0.9 (or newer) is not available, `build Yosys from source`_.
|
If Yosys 0.9 (or newer) is not available, `build Yosys from source`_.
|
||||||
|
|
||||||
.. rubric:: Other distributions
|
.. platform-choice:: linux
|
||||||
|
:title: Other Linux
|
||||||
|
|
||||||
Install Python and GTKWave from the package repository of your distribution.
|
Install Python and GTKWave from the package repository of your distribution.
|
||||||
|
|
||||||
|
@ -95,9 +95,9 @@ Latest release
|
||||||
|
|
||||||
.. |release:install| replace:: To install the latest release of nMigen, run:
|
.. |release:install| replace:: To install the latest release of nMigen, run:
|
||||||
|
|
||||||
.. content-tabs::
|
.. platform-picker::
|
||||||
|
|
||||||
.. tab-container:: windows
|
.. platform-choice:: windows
|
||||||
:title: Windows
|
:title: Windows
|
||||||
|
|
||||||
|release:install|
|
|release:install|
|
||||||
|
@ -106,7 +106,7 @@ Latest release
|
||||||
|
|
||||||
> pip install --upgrade nmigen[builtin-yosys]
|
> pip install --upgrade nmigen[builtin-yosys]
|
||||||
|
|
||||||
.. tab-container:: macos
|
.. platform-choice:: macos
|
||||||
:title: macOS
|
:title: macOS
|
||||||
|
|
||||||
|release:install|
|
|release:install|
|
||||||
|
@ -115,7 +115,7 @@ Latest release
|
||||||
|
|
||||||
$ pip install --user --upgrade 'nmigen[builtin-yosys]'
|
$ pip install --user --upgrade 'nmigen[builtin-yosys]'
|
||||||
|
|
||||||
.. tab-container:: linux
|
.. platform-choice:: linux
|
||||||
:title: Linux
|
:title: Linux
|
||||||
|
|
||||||
If you **did not** install Yosys manually in the :ref:`previous step <install-deps>`, to install the latest release of nMigen, run:
|
If you **did not** install Yosys manually in the :ref:`previous step <install-deps>`, to install the latest release of nMigen, run:
|
||||||
|
@ -138,9 +138,9 @@ Development snapshot
|
||||||
|
|
||||||
.. |snapshot:install| replace:: To install the latest development snapshot of nMigen, run:
|
.. |snapshot:install| replace:: To install the latest development snapshot of nMigen, run:
|
||||||
|
|
||||||
.. content-tabs::
|
.. platform-picker::
|
||||||
|
|
||||||
.. tab-container:: windows
|
.. platform-choice:: windows
|
||||||
:title: Windows
|
:title: Windows
|
||||||
|
|
||||||
|snapshot:install|
|
|snapshot:install|
|
||||||
|
@ -149,7 +149,7 @@ Development snapshot
|
||||||
|
|
||||||
> pip install git+https://github.com/nmigen/nmigen.git#egg=nmigen[builtin-yosys]
|
> pip install git+https://github.com/nmigen/nmigen.git#egg=nmigen[builtin-yosys]
|
||||||
|
|
||||||
.. tab-container:: macos
|
.. platform-choice:: macos
|
||||||
:title: macOS
|
:title: macOS
|
||||||
|
|
||||||
|snapshot:install|
|
|snapshot:install|
|
||||||
|
@ -158,7 +158,7 @@ Development snapshot
|
||||||
|
|
||||||
$ pip install --user 'git+https://github.com/nmigen/nmigen.git#egg=nmigen[builtin-yosys]'
|
$ pip install --user 'git+https://github.com/nmigen/nmigen.git#egg=nmigen[builtin-yosys]'
|
||||||
|
|
||||||
.. tab-container:: linux
|
.. platform-choice:: linux
|
||||||
:title: Linux
|
:title: Linux
|
||||||
|
|
||||||
If you **did not** install Yosys manually in the :ref:`previous step <install-deps>`, to install the latest release of nMigen, run:
|
If you **did not** install Yosys manually in the :ref:`previous step <install-deps>`, to install the latest release of nMigen, run:
|
||||||
|
@ -183,9 +183,9 @@ Editable development snapshot
|
||||||
.. |develop:update| replace:: Any changes made to the ``nmigen`` directory will immediately affect any code that uses nMigen. To update the snapshot, run:
|
.. |develop:update| replace:: Any changes made to the ``nmigen`` directory will immediately affect any code that uses nMigen. To update the snapshot, run:
|
||||||
.. |develop:reinstall| replace:: each time the editable development snapshot is updated in case package dependencies have been added or changed. Otherwise, code using nMigen may misbehave or crash with an ``ImportError``.
|
.. |develop:reinstall| replace:: each time the editable development snapshot is updated in case package dependencies have been added or changed. Otherwise, code using nMigen may misbehave or crash with an ``ImportError``.
|
||||||
|
|
||||||
.. content-tabs::
|
.. platform-picker::
|
||||||
|
|
||||||
.. tab-container:: windows
|
.. platform-choice:: windows
|
||||||
:title: Windows
|
:title: Windows
|
||||||
|
|
||||||
|develop:first-time|
|
|develop:first-time|
|
||||||
|
@ -206,7 +206,7 @@ Editable development snapshot
|
||||||
|
|
||||||
Run the ``pip install --editable .[builtin-yosys]`` command |develop:reinstall|
|
Run the ``pip install --editable .[builtin-yosys]`` command |develop:reinstall|
|
||||||
|
|
||||||
.. tab-container:: macos
|
.. platform-choice:: macos
|
||||||
:title: macOS
|
:title: macOS
|
||||||
|
|
||||||
|develop:first-time|
|
|develop:first-time|
|
||||||
|
@ -227,7 +227,7 @@ Editable development snapshot
|
||||||
|
|
||||||
Run the ``pip install --editable .[builtin-yosys]`` command |develop:reinstall|
|
Run the ``pip install --editable .[builtin-yosys]`` command |develop:reinstall|
|
||||||
|
|
||||||
.. tab-container:: linux
|
.. platform-choice:: linux
|
||||||
:title: Linux
|
:title: Linux
|
||||||
|
|
||||||
If you **did** install Yosys manually in the :ref:`previous step <install-deps>`, omit ``[builtin-yosys]`` from the following commands.
|
If you **did** install Yosys manually in the :ref:`previous step <install-deps>`, omit ``[builtin-yosys]`` from the following commands.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
sphinx~=3.0
|
sphinx~=3.0
|
||||||
sphinxcontrib-contentui~=0.2.5
|
sphinxcontrib-platformpicker~=1.0
|
||||||
-e git+http://github.com/pygments/pygments.git#egg=pygments
|
-e git+http://github.com/pygments/pygments.git#egg=pygments
|
||||||
sphinx-rtd-theme~=0.5.0
|
sphinx-rtd-theme~=0.5.0
|
||||||
|
|
Loading…
Reference in a new issue