a481ea719f
Many commits squashed; turns out that with the combination of:
* Python v2.7,
* Sphinx v1.8.5, and
* Pygments v2.3.1
versions (old!) used in the CI, the only viable approach is:
* to use `code-block` directives with explicit language specification,
* to provide no file-local default using `highlight`, and
* to set language as `none` for grammar specifications.
Underlying are the following issues (again, for the old versions
listed above):
* Generic RST `code` doesn't work when language is `none`:
Warning, treated as error:
/root/project/docs/yul.rst:430:Cannot analyze code. No Pygments lexer found for "none".
Additionally, it might be trying to fall back to the default
(Solidity) if left unspecified.
* If a file-local default is specified using `highlight`, then
`code-block` _must_ also provide a language:
Warning, treated as error:
/root/project/docs/yul.rst:185:Error in "code-block" directive:
1 argument(s) required, 0 supplied.
* Sphinx seems to try the file-local default "yul" (specified with
`highlight`) on `code` marked having language `json`:
Warning, treated as error:
/root/project/docs/yul.rst:130:Could not lex literal_block as "yul". Highlighting skipped.
* The only well-lexed highlighter for two of the three grammar
specifications is `peg`, but it was added in Pygments v2.6.
One of the grammars - in the "Formal Specification" section,
the one after "We will use a destructuring notation for the
AST nodes." - _must_ be left unhighlighted, with language set
to `none`: all lexers do really poorly.
... And one should never, ever start treating warnings as mere
warnings, without having exhausted all other options.
Otherwise, it's a slippery slope, - and look where that brought
Gandhi: to being a strawman in every lousy argument to be had!..
|
||
|---|---|---|
| .circleci | ||
| .github/ISSUE_TEMPLATE | ||
| cmake | ||
| docs | ||
| libevmasm | ||
| liblangutil | ||
| libsolc | ||
| libsolidity | ||
| libsolutil | ||
| libyul | ||
| scripts | ||
| snap | ||
| solc | ||
| test | ||
| tools | ||
| .clang-format | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| appveyor.yml | ||
| Changelog.md | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| codecov.yml | ||
| CODING_STYLE.md | ||
| CONTRIBUTING.md | ||
| LICENSE.txt | ||
| README.md | ||
| ReleaseChecklist.md | ||
| SECURITY.md | ||
The Solidity Contract-Oriented Programming Language
You can talk to us on 
. Questions, feedback and suggestions are welcome!
Solidity is a statically typed, contract-oriented, high-level language for implementing smart contracts on the Ethereum platform.
Table of Contents
Background
Solidity is a statically-typed curly-braces programming language designed for developing smart contracts that run on the Ethereum Virtual Machine. Smart contracts are programs that are executed inside a peer-to-peer network where nobody has special authority over the execution, and thus they allow to implement tokens of value, ownership, voting and other kinds of logics.
When deploying contracts, you should use the latest released version of Solidity. This is because breaking changes as well as new features and bug fixes are introduced regularly. We currently use a 0.x version number to indicate this fast pace of change.
Build and Install
Instructions about how to build and install the Solidity compiler can be found in the Solidity documentation.
Example
A "Hello World" program in Solidity is of even less use than in other languages, but still:
pragma solidity ^0.6.0;
contract HelloWorld {
function helloWorld() external pure returns (string memory) {
return "Hello, World!";
}
}
To get started with Solidity, you can use Remix, which is an browser-based IDE. Here are some example contracts:
Documentation
The Solidity documentation is hosted at Read the docs.
Development
Solidity is still under development. Contributions are always welcome! Please follow the Developers Guide if you want to help.
You can find our current feature and bug priorities for forthcoming releases in the projects section.
Maintainers
License
Solidity is licensed under GNU General Public License v3.0.
Some third-party code has its own licensing terms.
Security
The security policy may be found here.