Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
_static
_static
 
 
_templates
_templates
 
 
contracts
contracts
 
 
examples
examples
 
 
ext
ext
 
 
grammar
grammar
 
 
internals
internals
 
 
types
types
 
 
050-breaking-changes.rst
050-breaking-changes.rst
 
 
060-breaking-changes.rst
060-breaking-changes.rst
 
 
070-breaking-changes.rst
070-breaking-changes.rst
 
 
080-breaking-changes.rst
080-breaking-changes.rst
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
abi-spec.rst
abi-spec.rst
 
 
analysing-compilation-output.rst
analysing-compilation-output.rst
 
 
assembly.rst
assembly.rst
 
 
brand-guide.rst
brand-guide.rst
 
 
bugs.json
bugs.json
 
 
bugs.rst
bugs.rst
 
 
bugs_by_version.json
bugs_by_version.json
 
 
cheatsheet.rst
cheatsheet.rst
 
 
common-patterns.rst
common-patterns.rst
 
 
conf.py
conf.py
 
 
contracts.rst
contracts.rst
 
 
contributing.rst
contributing.rst
 
 
control-structures.rst
control-structures.rst
 
 
credits-and-attribution.rst
credits-and-attribution.rst
 
 
docs.sh
docs.sh
 
 
grammar.rst
grammar.rst
 
 
index.rst
index.rst
 
 
installing-solidity.rst
installing-solidity.rst
 
 
introduction-to-smart-contracts.rst
introduction-to-smart-contracts.rst
 
 
ir-breaking-changes.rst
ir-breaking-changes.rst
 
 
language-influences.rst
language-influences.rst
 
 
layout-of-source-files.rst
layout-of-source-files.rst
 
 
logo.svg
logo.svg
 
 
make.bat
make.bat
 
 
metadata.rst
metadata.rst
 
 
natspec-format.rst
natspec-format.rst
 
 
path-resolution.rst
path-resolution.rst
 
 
requirements.txt
requirements.txt
 
 
resources.rst
resources.rst
 
 
robots.txt.template
robots.txt.template
 
 
security-considerations.rst
security-considerations.rst
 
 
smtchecker.rst
smtchecker.rst
 
 
solidity-by-example.rst
solidity-by-example.rst
 
 
solidity_logo.svg
solidity_logo.svg
 
 
structure-of-a-contract.rst
structure-of-a-contract.rst
 
 
style-guide.rst
style-guide.rst
 
 
types.rst
types.rst
 
 
units-and-global-variables.rst
units-and-global-variables.rst
 
 
using-the-compiler.rst
using-the-compiler.rst
 
 
yul.rst
yul.rst
 
 

README.md

Solidity Language Docs

Local environment setup

  1. Install python https://www.python.org/downloads/
  2. Install sphinx (the tool used to generate the docs) https://www.sphinx-doc.org/en/master/usage/installation.html

Go to /docs and run ./docs.sh to install dependencies and build the project:

cd docs
./docs.sh

That will output the generated htmls under _build/

Serve environment

python3 -m http.server -d _build/html --cgi 8080

Visit dev server at http://localhost:8080