Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: m-labs/misoc
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 6db831e5a830
Choose a base ref
...
head repository: m-labs/misoc
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 0267868cbe87
Choose a head ref

Commits on Jan 27, 2015

  1. init repo

    enjoy-digital committed Jan 27, 2015
    Copy the full SHA
    a160b04 View commit details
  2. Copy the full SHA
    46c4841 View commit details
  3. Copy the full SHA
    0826811 View commit details
  4. start code adaptation

    enjoy-digital committed Jan 27, 2015
    Copy the full SHA
    8477974 View commit details

Commits on Jan 28, 2015

  1. Copy the full SHA
    4cd73fc View commit details
  2. Copy the full SHA
    8a2b65f View commit details
  3. Copy the full SHA
    0953752 View commit details
  4. Copy the full SHA
    e42fdb4 View commit details
  5. setup.py: fix

    enjoy-digital committed Jan 28, 2015
    Copy the full SHA
    8a42d74 View commit details
  6. Copy the full SHA
    33edf11 View commit details
  7. test: mac_core_tb OK

    enjoy-digital committed Jan 28, 2015
    Copy the full SHA
    fb00202 View commit details
  8. Copy the full SHA
    44113d7 View commit details
  9. Copy the full SHA
    ddf0579 View commit details
  10. Copy the full SHA
    98b8234 View commit details
  11. Copy the full SHA
    6249209 View commit details
  12. Copy the full SHA
    dc5e1aa View commit details
  13. Copy the full SHA
    5b37068 View commit details

Commits on Jan 29, 2015

  1. Copy the full SHA
    51c9f84 View commit details
  2. Copy the full SHA
    cb9ec51 View commit details
  3. Copy the full SHA
    96b08a0 View commit details
  4. model: add arp skeleton

    enjoy-digital committed Jan 29, 2015
    Copy the full SHA
    dcbfdca View commit details
  5. arp: add skeleton

    enjoy-digital committed Jan 29, 2015
    Copy the full SHA
    8d9357d View commit details
  6. Copy the full SHA
    08e83af View commit details
  7. Copy the full SHA
    18a7d66 View commit details

Commits on Jan 30, 2015

  1. arp: rx and decoding OK

    enjoy-digital committed Jan 30, 2015
    Copy the full SHA
    a7d4427 View commit details
  2. Copy the full SHA
    fa48346 View commit details
  3. arp: little clean up

    enjoy-digital committed Jan 30, 2015
    Copy the full SHA
    41ead49 View commit details
  4. ip: add skeleton

    enjoy-digital committed Jan 30, 2015
    Copy the full SHA
    1d447f2 View commit details
  5. Copy the full SHA
    124a041 View commit details
  6. Copy the full SHA
    d066497 View commit details
  7. add ip model skeleton

    enjoy-digital committed Jan 30, 2015
    Copy the full SHA
    328295c View commit details
  8. use ip model in ip_tb

    enjoy-digital committed Jan 30, 2015
    Copy the full SHA
    1c2030d View commit details
  9. Copy the full SHA
    6e966be View commit details
  10. clean up

    enjoy-digital committed Jan 30, 2015
    Copy the full SHA
    d7c7fd3 View commit details

Commits on Feb 4, 2015

  1. ip: small clean up

    enjoy-digital committed Feb 4, 2015
    Copy the full SHA
    df2f283 View commit details
  2. Copy the full SHA
    99323b4 View commit details
  3. Copy the full SHA
    34dad82 View commit details
  4. Copy the full SHA
    97daf9b View commit details
  5. reorganize core files

    enjoy-digital committed Feb 4, 2015
    Copy the full SHA
    957c162 View commit details
  6. udp: add model

    enjoy-digital committed Feb 4, 2015
    Copy the full SHA
    7a4713b View commit details
  7. udp: add skeleton

    enjoy-digital committed Feb 4, 2015
    Copy the full SHA
    90abd19 View commit details
  8. add udpip_tb skeleton

    enjoy-digital committed Feb 4, 2015
    Copy the full SHA
    4e5bd46 View commit details
  9. Copy the full SHA
    a9da9dc View commit details
  10. Copy the full SHA
    ca1e028 View commit details
  11. Copy the full SHA
    fa5ee3b View commit details

Commits on Feb 5, 2015

  1. Copy the full SHA
    afae3f0 View commit details
  2. Copy the full SHA
    b860e0b View commit details
  3. Copy the full SHA
    06a738f View commit details
  4. Copy the full SHA
    dbca377 View commit details
  5. Copy the full SHA
    8cf9883 View commit details
Showing with 10,220 additions and 8 deletions.
  1. +1 −0 .gitignore
  2. +0 −3 .gitmodules
  3. +0 −4 extcores/__init__.py
  4. +0 −1 extcores/litex
  5. +28 −0 misoclib/LICENSE
  6. +142 −0 misoclib/README
  7. +8 −0 misoclib/doc/.gitignore
  8. +157 −0 misoclib/doc/Makefile
  9. +220 −0 misoclib/doc/make.bat
  10. BIN misoclib/doc/source/_static/LiteEth_logo_full.png
  11. +246 −0 misoclib/doc/source/_static/LiteEth_logo_full.svg
  12. +17 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/__init__.py
  13. +11 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/breadcrumbs.html
  14. +100 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/footer.html
  15. +208 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/layout.html
  16. +205 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/layout_old.html
  17. +50 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/search.html
  18. +7 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/searchbox.html
  19. +1 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/static/css/badge_only.css
  20. +331 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/static/css/theme - prior to centering.css
  21. +512 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/static/css/theme.css
  22. BIN misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot
  23. +414 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg
  24. BIN misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf
  25. BIN misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff
  26. +47 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/static/js/theme.js
  27. +9 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/theme.conf
  28. +37 −0 misoclib/doc/source/_themes/enjoydigital_sphinx_rtd_theme/versions.html
  29. +402 −0 misoclib/doc/source/conf.py
  30. +7 −0 misoclib/doc/source/docs/core/index.rst
  31. +7 −0 misoclib/doc/source/docs/frontend/index.rst
  32. +7 −0 misoclib/doc/source/docs/getting_started/FAQ.rst
  33. +11 −0 misoclib/doc/source/docs/getting_started/bug_reports.rst
  34. +43 −0 misoclib/doc/source/docs/getting_started/downloads.rst
  35. +17 −0 misoclib/doc/source/docs/getting_started/index.rst
  36. +27 −0 misoclib/doc/source/docs/index.rst
  37. +59 −0 misoclib/doc/source/docs/intro/about.rst
  38. +5 −0 misoclib/doc/source/docs/intro/community.rst
  39. +15 −0 misoclib/doc/source/docs/intro/index.rst
  40. +47 −0 misoclib/doc/source/docs/intro/license.rst
  41. +13 −0 misoclib/doc/source/docs/intro/release_notes.rst
  42. +14 −0 misoclib/doc/source/docs/intro/talks_and_publications.rst
  43. +26 −0 misoclib/doc/source/home_page_layout.html
  44. +24 −0 misoclib/doc/source/index.rst
  45. +2 −0 misoclib/liteeth-version.txt
  46. 0 misoclib/liteeth/__init__.py
  47. +284 −0 misoclib/liteeth/common.py
  48. +19 −0 misoclib/liteeth/core/__init__.py
  49. +263 −0 misoclib/liteeth/core/arp/__init__.py
  50. +31 −0 misoclib/liteeth/core/etherbone/__init__.py
  51. +260 −0 misoclib/liteeth/core/etherbone/dissector/bit.lua
  52. +223 −0 misoclib/liteeth/core/etherbone/dissector/etherbone.lua
  53. +129 −0 misoclib/liteeth/core/etherbone/packet.py
  54. +24 −0 misoclib/liteeth/core/etherbone/probe.py
  55. +176 −0 misoclib/liteeth/core/etherbone/record.py
  56. +69 −0 misoclib/liteeth/core/etherbone/wishbone.py
  57. +138 −0 misoclib/liteeth/core/icmp/__init__.py
  58. +180 −0 misoclib/liteeth/core/ip/__init__.py
  59. +43 −0 misoclib/liteeth/core/ip/checksum.py
  60. +30 −0 misoclib/liteeth/core/ip/crossbar.py
  61. +97 −0 misoclib/liteeth/core/tty/__init__.py
  62. +125 −0 misoclib/liteeth/core/udp/__init__.py
  63. +47 −0 misoclib/liteeth/core/udp/crossbar.py
  64. +151 −0 misoclib/liteeth/generic/__init__.py
  65. +27 −0 misoclib/liteeth/generic/arbiter.py
  66. +31 −0 misoclib/liteeth/generic/crossbar.py
  67. +84 −0 misoclib/liteeth/generic/depacketizer.py
  68. +39 −0 misoclib/liteeth/generic/dispatcher.py
  69. +92 −0 misoclib/liteeth/generic/packetizer.py
  70. +33 −0 misoclib/liteeth/mac/__init__.py
  71. +46 −0 misoclib/liteeth/mac/common.py
  72. +83 −0 misoclib/liteeth/mac/core/__init__.py
  73. +277 −0 misoclib/liteeth/mac/core/crc.py
  74. +26 −0 misoclib/liteeth/mac/core/gap.py
  75. +38 −0 misoclib/liteeth/mac/core/last_be.py
  76. +47 −0 misoclib/liteeth/mac/core/padding.py
  77. +140 −0 misoclib/liteeth/mac/core/preamble.py
  78. 0 misoclib/liteeth/mac/frontend/__init__.py
  79. +254 −0 misoclib/liteeth/mac/frontend/sram.py
  80. +39 −0 misoclib/liteeth/mac/frontend/wishbone.py
  81. 0 misoclib/liteeth/phy/__init__.py
  82. +76 −0 misoclib/liteeth/phy/gmii.py
  83. +27 −0 misoclib/liteeth/phy/loopback.py
  84. +127 −0 misoclib/liteeth/phy/mii.py
  85. +43 −0 misoclib/liteeth/phy/sim.py
  86. +33 −0 misoclib/liteeth/test/Makefile
  87. 0 misoclib/liteeth/test/__init__.py
  88. +57 −0 misoclib/liteeth/test/arp_tb.py
  89. +162 −0 misoclib/liteeth/test/common.py
  90. +116 −0 misoclib/liteeth/test/etherbone_tb.py
  91. +58 −0 misoclib/liteeth/test/icmp_tb.py
  92. +59 −0 misoclib/liteeth/test/ip_tb.py
  93. +62 −0 misoclib/liteeth/test/mac_core_tb.py
  94. +145 −0 misoclib/liteeth/test/mac_wishbone_tb.py
  95. 0 misoclib/liteeth/test/model/__init__.py
  96. +152 −0 misoclib/liteeth/test/model/arp.py
  97. +90 −0 misoclib/liteeth/test/model/dumps.py
  98. +354 −0 misoclib/liteeth/test/model/etherbone.py
  99. +102 −0 misoclib/liteeth/test/model/icmp.py
  100. +148 −0 misoclib/liteeth/test/model/ip.py
  101. +150 −0 misoclib/liteeth/test/model/mac.py
  102. +56 −0 misoclib/liteeth/test/model/phy.py
  103. +117 −0 misoclib/liteeth/test/model/udp.py
  104. +70 −0 misoclib/liteeth/test/udp_tb.py
  105. +141 −0 misoclib/make.py
  106. +138 −0 misoclib/platforms/kc705.py
  107. +37 −0 misoclib/setup.py
  108. +26 −0 misoclib/targets/__init__.py
  109. +224 −0 misoclib/targets/base.py
  110. +71 −0 misoclib/targets/etherbone.py
  111. +42 −0 misoclib/targets/tty.py
  112. +69 −0 misoclib/targets/udp.py
  113. +33 −0 misoclib/test/make.py
  114. +60 −0 misoclib/test/test_etherbone.py
  115. +24 −0 misoclib/test/test_la.py
  116. +12 −0 misoclib/test/test_regs.py
  117. +36 −0 misoclib/test/test_tty.py
  118. +81 −0 misoclib/test/test_udp.py
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -11,3 +11,4 @@ tools/byteswap
software/include/generated/*.h
software/include/generated/*.ld
software/include/generated/*.mak
*.vcd
3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -7,6 +7,3 @@
[submodule "software/compiler-rt"]
path = software/compiler-rt
url = http://llvm.org/git/compiler-rt.git
[submodule "extcores/litex"]
path = extcores/litex
url = https://github.com/enjoy-digital/litex
4 changes: 0 additions & 4 deletions extcores/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +0,0 @@
import os, sys
sys.path.append(os.path.join("extcores", "litex", "litescope"))
sys.path.append(os.path.join("extcores", "litex", "liteeth"))
sys.path.append(os.path.join("extcores", "litex", "litesata"))
1 change: 0 additions & 1 deletion extcores/litex
Submodule litex deleted from 0dc0b6
28 changes: 28 additions & 0 deletions misoclib/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Unless otherwise noted, LiteEth is copyright (C) 2015 Florent Kermarrec.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Other authors retain ownership of their contributions. If a submission can
reasonably be considered independently copyrightable, it's yours and we
encourage you to claim it with appropriate copyright notices. This submission
then falls under the "otherwise noted" category. All submissions are strongly
encouraged to use the two-clause BSD license reproduced above.
142 changes: 142 additions & 0 deletions misoclib/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
__ _ __ ______ __
/ / (_) /____ / __/ /_/ /
/ /__/ / __/ -_) _// __/ _ \
/____/_/\__/\__/___/\__/_//_/

Copyright 2012-2015 / EnjoyDigital
florent@enjoy-digital.fr

A small footprint and configurable Ethernet core
with UDP/IP hw stack and Etherbone frontend
powered by Migen

[> Doc
---------
HTML : www.enjoy-digital.fr/litex/liteeth/
PDF : www.enjoy-digital.fr/litex/liteeth.pdf

[> Intro
---------
LiteEth provides a small footprint and configurable Ethernet core.

LiteEth is part of LiteX libraries whose aims are to lower entry level of
complex FPGA cores by providing simple, elegant and efficient implementations
ofcomponents used in today's SoC such as Ethernet, SATA, PCIe, SDRAM Controller...

The core uses simple and specific streaming buses and will provides in the future
adapters to use standardized AXI or Avalon-ST streaming buses.

Since Python is used to describe the HDL, the core is highly and easily
configurable.

LiteEth uses technologies developed in partnership with M-Labs Ltd:
- Migen enables generating HDL with Python in an efficient way.
- MiSoC provides the basic blocks to build a powerful and small footprint SoC.

LiteEth can be used as a Migen/MiSoC library (by simply installing it
with the provided setup.py) or can be integrated with your standard design flow
by generating the verilog rtl that you will use as a standard core.

[> Features
-----------
- Ethernet MAC with various interfaces and various PHYs (GMII, MII, Loopback)
- Hardware UDP/IP stack with ARP and ICMP

[> Possible improvements
-------------------------
- add standardized interfaces (AXI, Avalon-ST)
- add DMA interface to MAC
- add RGMII/SGMII PHYs
- ... See below Support and consulting :)

If you want to support these features, please contact us at florent [AT]
enjoy-digital.fr. You can also contact our partner on the public mailing list
devel [AT] lists.m-labs.hk.


[> Getting started
------------------
1. Install Python3 and your vendor's software

2. Obtain Migen and install it:
git clone https://github.com/m-labs/migen
cd migen
python3 setup.py install
cd ..

Note: in case you have issues with Migen, please retry
with our fork at:
https://github.com/enjoy-digital/misoc
until new features are merged.

3. Obtain LiteScope and install it:
git clone https://github.com/enjoy-digital/litescope
cd litescope
python3 setup.py install
cd ..

4. Obtain LiteEth
git clone https://github.com/enjoy-digital/liteeth

5. Build and load UDP loopback design (only for KC705 for now):
python3 make.py -t udp all

6. Test design (only for KC705 for now):
try to ping 192.168.1.40
go to ./test directory:
change com port in config.py to your com port
run make test_udp

7. Build and load Etherbone design (only for KC705 for now):
python3 make.py -t etherbone all

8. Test design (only for KC705 for now):
try to ping 192.168.1.40
go to ./test directory run:
run make test_etherbone

[> Simulations:
Simulations are available in ./liteth/test/:
- mac_core_tb
- mac_wishbone_tb
- arp_tb
- ip_tb
- icmp_tb
- udp_tb
All ethernet layers have their own model tested against real Ethernet dumps (dumps.py)
To run a simulation, move to ./liteeth/test and run:
make simulation_name

[> Tests :
An UDP loopback example is provided and be controlled with: ./test/test_udp.py
An Etherbone example with Wishbone SRAM is provided and can be controlled with:
./test/test_etherbone.py

[> License
-----------
LiteEth is released under the very permissive two-clause BSD license. Under
the terms of this license, you are authorized to use LiteEth for closed-source
proprietary designs.
Even though we do not require you to do so, those things are awesome, so please
do them if possible:
- tell us that you are using LiteEth
- cite LiteEth in publications related to research it has helped
- send us feedback and suggestions for improvements
- send us bug reports when something goes wrong
- send us the modifications and improvements you have done to LiteEth.

[> Support and consulting
--------------------------
We love open-source hardware and like sharing our designs with others.

LiteEth is developed and maintained by EnjoyDigital.

If you would like to know more about LiteEth or if you are already a happy
user and would like to extend it for your needs, EnjoyDigital can provide standard
commercial support as well as consulting services.

So feel free to contact us, we'd love to work with you! (and eventually shorten
the list of the possible improvements :)

[> Contact
E-mail: florent [AT] enjoy-digital.fr
8 changes: 8 additions & 0 deletions misoclib/doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
*.diff
*.pyc
*~
*.bc
*.md

# Ignore generated files
build/
157 changes: 157 additions & 0 deletions misoclib/doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"

clean:
rm -rf $(BUILDDIR)/*

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."

json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."

htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."

epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."

latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."

info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
Loading