Commit Graph

31 Commits

Author SHA1 Message Date
Noel Maersk
a481ea719f
docs: use Yul lexer to highlight Yul code segments.
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!..
2020-04-26 20:48:07 +03:00
iamdefinitelyahuman
c59854c4bb docs: add dark mode to documentation 2020-04-20 20:23:45 +04:00
chriseth
33f990a96a Fix style of documentation config. 2020-02-04 17:01:13 +01:00
Erik Kundt
a2f28f0a9d Fixes copyright in readthedocs config. 2020-01-28 16:38:20 +01:00
Chris Ward
06ca903b37 Split voting example into seperate file 2019-01-14 09:41:10 +02:00
Chris Ward
874174bd47 Split Value Types docs 2019-01-09 12:06:37 +01:00
chriseth
3503f3809d Do not compile the contracts subdirectory. 2019-01-07 17:52:31 +01:00
chandan kumar mandal
fdd24d12f3
copyright year updated
Happy New Year !! 🎇
Copyright year udated to 2019.
2019-01-02 02:54:43 +05:30
chriseth
4fc15a5beb Fix table css. 2018-08-09 22:42:29 +02:00
Shadab Khan
a673785326 Add custom.css for docs to change pre tag styles
Specify white space for table cells

Add custom.css for docs to change pre tag styles

Specify white space for table cells

Rearrange code

Delete theme_overrides.css

Remove extra code
2018-07-04 00:08:59 +05:30
wpank
3cc780de33 Added static CSS to Sphinx in order to fix bug with RTD theme table wrapping 2018-06-27 12:01:48 -07:00
Noel Maersk
3678450549 docs: change default theme to RTD's.
RTD probably has their `default` theme set to their own `rtd` theme,
while CircleCI has some regular default Sphinx theme.

This changes the Sphinx project configuration to use `rtd` as the
theme.
2018-05-24 14:21:19 +03:00
Noel Maersk
7acf5d5244 docs: use SolidityLexer from pygments_lexer_solidity package. 2018-05-23 16:56:51 +03:00
chriseth
2f4faef606 Do not depend on where build is run. 2018-05-14 21:59:35 +02:00
Magicking
f28b6e55f1
docs: Update configuration from 2017 to 2018 2018-04-27 08:31:27 +02:00
Alex Beregszaszi
e5e0eae057 Take documentation version numbers from CMake 2017-02-06 16:00:29 +00:00
chriseth
ffe4ce0891 Version update 2017-01-31 19:37:55 +01:00
Alex Beregszaszi
2bf89776ae Update copyright date in docs 2017-01-17 13:08:22 +00:00
chriseth
10c2df8b33 Update version to 0.4.9. 2017-01-13 13:56:55 +01:00
chriseth
7ce7d3e74c Update develop version. 2016-12-15 14:03:31 +01:00
chriseth
a65473b371 Set version to 0.4.7 2016-11-22 15:44:48 +01:00
chriseth
3f48c655e5 Update version. 2016-11-21 11:54:41 +01:00
chriseth
4f9741c0cf Version update in develop. 2016-11-01 09:58:02 +01:00
chriseth
5ddb92b8cc Version bump for develop. 2016-10-25 15:39:38 +02:00
chriseth
0165814ec4 Bump version in develop. 2016-09-17 15:27:46 +02:00
Nick Savers
ba7199720d Update Solidity docs version to 0.4.1 2016-09-09 21:36:59 +02:00
Denton Liu
f8aec4d89e Update copyright 2016-07-11 17:04:44 -04:00
chriseth
798775fa1b Corrected errors. 2016-05-18 21:59:41 +02:00
chriseth
c7ec85754a Pygments highlighting rules for Solidity. 2015-12-10 17:30:33 +01:00
chriseth
99bb8a9740 Add pdf config. 2015-12-07 23:35:39 +01:00
chriseth
64fa9ca478 Imported documentation. 2015-12-07 22:35:51 +01:00