cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
0fa594e501
solidity/docs
History
Paul Wackerow 0fa594e501
fix docs layout and link bugs [Fixes #14436] (#14439) 
using cdnfonts import instead

fix mobile menu layout

fix mobile content positioning/sizing

fix desktop content widths

prevent header links from wrapping

update desktop positioning

fix backdrop-filter

move to .unified-header::before

feat: independent scrolling for content and menu
2023-07-26 14:17:38 +01:00
..
_static fix docs layout and link bugs [Fixes #14436] (#14439) 2023-07-26 14:17:38 +01:00
_templates restoring the RTD section. Downloads section to still be above versions section 2021-11-30 00:20:27 +05:30
contracts Relax restrictions on immutable initialization 2023-07-14 15:29:32 +02:00
examples Misspelling and terms inconsistencies (#14280) 2023-05-30 20:49:25 +01:00
ext docs: change the remix button from icon to text (#14122) 2023-04-27 11:02:04 +01:00
grammar Fix antlr grammar. 2023-05-10 12:00:45 +02:00
internals Properly document FullInliner's prerequisites 2023-07-17 16:40:43 +02:00
types Small documentation fixes 2023-07-21 23:23:20 +02:00
050-breaking-changes.rst Misspelling and terms inconsistencies (#14280) 2023-05-30 20:49:25 +01:00
060-breaking-changes.rst Fix typos 2023-07-19 17:12:15 +02:00
070-breaking-changes.rst 0.7.0 breaking changes: There were no external constructors 2021-04-22 21:57:20 +02:00
080-breaking-changes.rst Misspelling and terms inconsistencies (#14280) 2023-05-30 20:49:25 +01:00
abi-spec.rst Misspelling and terms inconsistencies (#14280) 2023-05-30 20:49:25 +01:00
analysing-compilation-output.rst docs: change the remix button from icon to text (#14122) 2023-04-27 11:02:04 +01:00
assembly.rst Misspelling and terms inconsistencies (#14280) 2023-05-30 20:49:25 +01:00
brand-guide.rst Remove redundant typo 2021-12-13 11:36:07 +01:00
bugs_by_version.json Set release date for 0.8.21 2023-07-19 09:27:09 +02:00
bugs.json Add buglist entry 2023-07-18 18:15:32 +02:00
bugs.rst Replace Javascript with JavaScript 2023-03-28 22:59:48 +09:00
cheatsheet.rst Relax restrictions on immutable initialization 2023-07-14 15:29:32 +02:00
common-patterns.rst Changed references to money 2023-05-22 12:54:43 +01:00
conf.py fix docs layout and link bugs [Fixes #14436] (#14439) 2023-07-26 14:17:38 +01:00
contracts.rst Documentation for custom errors. 2021-03-30 23:04:32 +02:00
contributing.rst cmdlineTests.sh: Add --exclude option 2023-06-19 16:43:30 +02:00
control-structures.rst Misspelling and terms inconsistencies (#14280) 2023-05-30 20:49:25 +01:00
credits-and-attribution.rst Rename share-solid.svg to avoid it being blocked by adblockers 2021-10-08 13:57:49 +02:00
docs.sh docs.sh: Fail on all errors, includding undefined variables and failures in piped commands 2022-04-08 20:41:31 +02:00
grammar.rst Fix import path grammar and grammar testing details. 2021-04-12 14:54:36 +02:00
index.rst Fix gitter link. 2023-05-10 11:38:24 +02:00
installing-solidity.rst Fix broken links in docs 2023-07-18 18:25:48 +02:00
introduction-to-smart-contracts.rst Misspelling and terms inconsistencies (#14280) 2023-05-30 20:49:25 +01:00
ir-breaking-changes.rst Relax restrictions on immutable initialization 2023-07-14 15:29:32 +02:00
language-influences.rst adding language influences page 2021-04-22 10:46:11 +02:00
layout-of-source-files.rst docs: Replace some links with redirects found by linkcheck 2023-02-01 12:26:44 +01:00
logo.svg Squashed commit of the following: (#14401) 2023-07-14 19:31:06 +01:00
make.bat fix(docs): fix missing backticks, remove latexpdfja, fix the missing help message of latexpdf, and remove unnecessary whitespace (#14101) 2023-04-14 12:24:50 +01:00
Makefile fix(docs): fix missing backticks, remove latexpdfja, fix the missing help message of latexpdf, and remove unnecessary whitespace (#14101) 2023-04-14 12:24:50 +01:00
metadata.rst Misspelling and terms inconsistencies (#14280) 2023-05-30 20:49:25 +01:00
natspec-format.rst docs: change the remix button from icon to text (#14122) 2023-04-27 11:02:04 +01:00
path-resolution.rst Small documentation fixes 2023-07-21 23:23:20 +02:00
README.md Squashed commit of the following: (#14401) 2023-07-14 19:31:06 +01:00
requirements.txt Update sphinx-a4doc version 2023-01-04 11:46:59 +01:00
resources.rst Fix broken links in docs 2023-07-18 18:25:48 +02:00
robots.txt.template Set preferred host in robots.txt 2021-06-28 21:26:00 +01:00
security-considerations.rst Changed references to money 2023-05-22 12:54:43 +01:00
smtchecker.rst fix docs 2023-07-10 21:22:10 +09:00
solidity-by-example.rst Add basic modular contract example 2019-02-15 13:55:38 -07:00
structure-of-a-contract.rst docs: Replace > with >= in pragmas to work around the highligher being unable to process the former 2021-07-15 10:14:00 +02:00
style-guide.rst Misspelling and terms inconsistencies (#14280) 2023-05-30 20:49:25 +01:00
types.rst docs: fix formatting errors and style inconsistencies 2020-04-20 20:24:31 +04:00
units-and-global-variables.rst fix docs 2023-07-10 21:22:10 +09:00
using-the-compiler.rst Small documentation fixes 2023-07-21 23:23:20 +02:00
yul.rst Small documentation fixes 2023-07-21 23:23:20 +02:00

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