crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
protocol/docs
History
wonge97 d7bc0b79df
Doc update (#675) 
* Update existing protocol docs to point to protocol-specific resources

Remove documentation of outdated/irrelevant portions of the protocol

* pin jinja version to try to fixbuild failure. (#711)

---------

Co-authored-by: Eric Wong <ewong@Erics-MBP.fios-router.home>
2023-04-19 12:22:58 -05:00
..
_drawio
minor doc improvements (#57)
2020-11-28 11:21:35 -08:00
_static
Doc update (#675)
2023-04-19 12:22:58 -05:00
additional
fix: Bug Bounty git sha c1177416f5 (#626)
2022-12-26 09:54:20 +02:00
advanced
Migrate erc20-contracts to foundry (#664)
2023-02-19 20:04:24 +02:00
architecture
Doc update (#675)
2023-04-19 12:22:58 -05:00
basics
Doc update (#675)
2023-04-19 12:22:58 -05:00
guides
Doc update (#675)
2023-04-19 12:22:58 -05:00
scripts
Update protocol docs (#421)
2022-02-11 22:53:49 +10:00
.gitignore
V4 Docs. See live on https://0xprotocol.readthedocs.io. (#56)
2020-11-28 00:51:50 -08:00
conf.py
Update protocol docs (#421)
2022-02-11 22:53:49 +10:00
index.rst
Doc update (#675)
2023-04-19 12:22:58 -05:00
make.bat
Adds Template for Specs (#12)
2020-10-27 16:31:15 -07:00
Makefile
V4 Docs. See live on https://0xprotocol.readthedocs.io. (#56)
2020-11-28 00:51:50 -08:00
README.md
V4 Docs. See live on https://0xprotocol.readthedocs.io. (#56)
2020-11-28 00:51:50 -08:00
requirements.txt
Doc update (#675)
2023-04-19 12:22:58 -05:00

README.md

Dependencies

    pip3 install sphinx recommonmark sphinx-rtd-theme

Syntax

Documentation can be written in Markdown (.md) or Restructured Text (.rst).

Build and Test

cd docs
make html
open _build/html/index.html

Tips

  • Generate RST tables here.
  • Set your editor's wordwrap to 98 characters.