Commit Graph

51 Commits

Author SHA1 Message Date
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
Paul Wackerow
11be2f4881
Squashed commit of the following: (#14401)
commit 6f38009a31b2ff5d6f53de7b74469f495fe04092
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 10 15:36:03 2023 -0700

    remove default sphinx footer

commit 0d842749566f40fa8c2dd434fa67bcc5e9df3aa0
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 10 15:21:26 2023 -0700

    linting

commit c8484ac7c1f54067b0d3c4aa4aa81de7d36df71d
Merge: 8339800d0 b583e9e64
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 10 14:15:03 2023 -0700

    Merge branch 'develop' into docs-rebrand

commit 8339800d0fdd197f589337e1198867d4198a3850
Merge: 633c673c5 88d5e06d4
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 10 14:11:58 2023 -0700

    Merge branch 'rebrand' into docs-rebrand

commit 88d5e06d4ce79696b9451991b33834ecc55bf66d
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 10 14:11:52 2023 -0700

    remove dev code

commit 633c673c5e227009917d888e1f0991f33aa75f44
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 10 14:02:25 2023 -0700

    update home url poitner to production domain

commit b3689cb7c230e1fb3a97400e5412ec14c34fc586
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 10 13:59:34 2023 -0700

    fix external link arrow to match core site

commit b7a28a5dfe7517a88870afe67783e9e300b85af4
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 10 13:59:19 2023 -0700

    swap in cdnfonts for overpass fonts

commit e979ad5c9f69c9c7ee369a0700a64ea6d9061c2b
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 10 08:30:48 2023 -0700

    fix external link arrow spacing/underline

commit b90077863cfff5d8776f5dc74f82f061e0162d37
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Thu Jul 6 16:26:28 2023 -0700

    update foot note

commit ed9ddfd327cd0e382286abf0c8896c7c879512b2
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Thu Jul 6 13:12:14 2023 -0700

    update nav link hover color

commit 077d3a0c9333c96cbabc3ce2bccf00afac19a312
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Tue Jul 4 20:27:05 2023 -0700

    bug fixed for header/nav-link styling

commit 2584dd2e419255ec93430446bd049ff90155987e
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Tue Jul 4 12:15:09 2023 -0700

    fix link shift bug

commit 885d2bc52ca3ed9e4727d7f0eaed0e312fedaaaa
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Tue Jul 4 12:13:03 2023 -0700

    update nav link hover styling

commit d06c81592ad88ad2e81701cec9e85b6a3cee86ee
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 3 18:25:37 2023 -0700

    extract event listener functions

commit 414e444ee67fe937d1295b14ac8591a710bfbdff
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jul 3 18:22:08 2023 -0700

    a11y: skip to content link

commit 6c628ea73995dad9b9a6fb502bb216d88f0e9602
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 21:57:24 2023 -0700

    fine-tuning more styling

commit 71b617abaf27c34fcecaf6e30795687abf9885f7
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 21:37:02 2023 -0700

    fix primary link color

commit d90627418c605bff4398a9e24ae0c5c685f73992
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 21:21:30 2023 -0700

    fix mobile versions expansion

commit f0f0fbbcb74ea35efa6e4cf87ab1d855f1ae2bd2
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 21:21:16 2023 -0700

    update code styling

commit 727c7ee9b69427eddd73012a89e6ee9ae1ccec8d
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 21:20:38 2023 -0700

    remix link styling

commit 4059c00e3d704002ef34f85fd86495f2a4ac9e57
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 21:19:49 2023 -0700

    fix whitespace styling

commit 631e2910a53484b97770cad1b3439d412a0ab6d0
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 20:33:54 2023 -0700

    fix search input styling

commit 5e06b22a7200b0774bd135c666b4e3437d342350
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 19:37:19 2023 -0700

    css adjustments

commit 637d5122038fd6075cd53d57537d728b730acbcf
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 19:15:05 2023 -0700

    selector adjustments, linting

commit 781dc7c3009dc406b36cd2bdcb2d02c3c34fafa6
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 18:26:09 2023 -0700

    top version/search layout adjustments

commit 7341e17003700133659e5f64ee2d1369ac50e434
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jul 2 18:18:21 2023 -0700

    update version div styling

commit 3a4b3feb581b1799e48d395b73aca05760dc5658
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sat Jul 1 21:18:12 2023 -0700

    restyle external link arrow for forum link

commit e6cef6312ca73c125c01b78573f21c75fcbbfc87
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sat Jul 1 20:50:31 2023 -0700

    add woff2 fonts, use absolute font urls

commit 3bc401b1dbe971501826011a692c38ee9ce4b992
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sat Jul 1 15:15:26 2023 -0700

    fix nav button alignment

commit b7d607b7090e1ac6ded55ac6e534549609226236
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Fri Jun 30 19:02:24 2023 -0700

    rename pcm param to color

commit d67e23539f720250bb298c11fd2b1b6d7dbb0815
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Fri Jun 30 17:34:56 2023 -0700

    center align footer buttons, fix bug on pre text

commit 34a665038dc27e2b8874b3e16ffc581c33f31bc5
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Thu Jun 29 16:40:26 2023 -0700

    preload fonts

commit 5b987c31455ffe02135e357ea560bbad8a9c6745
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Thu Jun 29 15:31:41 2023 -0700

    antialiased font smoothing

commit 9585fb5bb73f67e37a4f9f1da83e7b133f0b4446
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Thu Jun 29 13:44:51 2023 -0700

    search results styling

commit 224ed028b181b3944d2f2e33f4122b15f38f7608
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Thu Jun 29 13:29:09 2023 -0700

    restore search functionality

commit ec5782a01cd0f1c1808b353560c39911c9fdc645
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Wed Jun 28 21:55:11 2023 -0700

    more mobile menu and styling fixes

commit c033f05e2ab839309e7d3864ae66c465d801e806
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Wed Jun 28 13:14:22 2023 -0700

    patch location cleaner

commit 6cae3b5ad67e38f6decfa18eeacce973783a2fc1
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Tue Jun 27 17:49:28 2023 -0700

    patch location cleaner

commit e86e6a11189ed57f122382c901fe7a0f49518e83
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Tue Jun 27 17:40:11 2023 -0700

    color mode continuity

commit c3ba4ee6c614fa637a34eacbae60c5e88cd018c5
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Tue Jun 27 15:32:11 2023 -0700

    refactor layout

commit ac3bae8f34ccbd08f68cb784b3ec00bad70a9281
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jun 26 14:35:00 2023 -0700

    color and styling updates

commit 42e301818d3d11152c5ce630c8085db1c1664a13
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jun 26 13:23:03 2023 -0700

    highlight active nav link

commit fb72573c01494486ab9b0942c3f67c372af0d5e6
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jun 26 12:34:25 2023 -0700

    patch mobile menu bottom scroll stop

commit 2dcef754301d35143ea24ca197906c974e128a25
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Mon Jun 26 12:32:38 2023 -0700

    adjust header icon sizes

commit dc75b636b7f442dfe7aaa80ad82470be0f3d4f19
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jun 25 21:41:18 2023 -0700

    fix header icon sizes

commit de70f1a56eba85c89c1f01f37770b1d6bd91d5db
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sun Jun 25 19:58:18 2023 -0700

    mobile meun debugging

commit 1fe20565a838c2f2212cd95045cd309b076c8b2b
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sat Jun 24 13:21:23 2023 -0700

    icon color mode improvements

commit fcb134a4209371277693e919fb06eaeb53e36cb6
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sat Jun 24 11:51:24 2023 -0700

    initialize with menu closed

commit defa7c78e981037409ec9d2b9ab871910023f5b0
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Sat Jun 24 11:37:47 2023 -0700

    color toggle and mobile menu

commit 695d719612be0ed9cac0f246f0eaf91f3fdb2e75
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Fri Jun 23 16:39:32 2023 -0700

    forum url as external link

commit ad182602095909d84331339993b31f2a37bf1cd7
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Fri Jun 23 16:28:14 2023 -0700

    patch contributing path

commit fbfeaa7a12a1b9bc86b766a0e490b85d2ded8849
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Fri Jun 23 16:20:57 2023 -0700

    update contribute path

commit f7dbf1f2e0a3e31d164d6cc67c952f89c3f8f49e
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Fri Jun 23 16:05:22 2023 -0700

    dev: point to vercel build for new solidity site

commit c344c1df86e78ad6ab9bc066ac75659180d068cf
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Fri Jun 23 14:30:40 2023 -0700

    update stylesheets, constants, logos

commit c15135378c8568ed93bf685552940cdbe1c07b70
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Fri Jun 23 10:25:05 2023 -0700

    bg color cleanup

commit c049df77d9d55adc796bc2f8cd7c186d833aca69
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Thu Jun 22 19:02:49 2023 -0700

    clean up initialize and toggle scripts

    deprecate dark.css in lieu of a dark more html attribute indicator and css selectors for this attribute. Avoids needing to enable/disable dark stylesheet

commit 881c9cce66e18d30b50c467a22d98836698f5b58
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Thu Jun 22 18:59:24 2023 -0700

    import type faces

commit e9b26157aabf4374754cf14d9a4a980c92bd139c
Author: Paul Wackerow <54227730+wackerow@users.noreply.github.com>
Date:   Thu Jun 22 15:39:00 2023 -0700

    implement initial styling adjustments
2023-07-14 19:31:06 +01:00
minaminao
26c769fe8e fix: not displaying svg image 2023-04-06 01:35:09 +09:00
franzihei
6cad055d97
[DOCS] Update copyright year and description (#13894)
Co-authored-by: Nuno Santos <nuno.santos@ethereum.org>
Co-authored-by: Kamil Śliwak <kamil.sliwak@codepoets.it>
2023-02-01 11:47:08 +01:00
Kaan Uzdogan
a98bb41bd3 Add Solidity favicon to docs 2022-12-14 18:15:50 +01:00
Kamil Śliwak
dece5f4de2 pylint: Enable and fix redefined-builtin warnings 2021-12-21 15:30:11 +01:00
Kamil Śliwak
5b10ff1216 pylint: Enable and fix singleton-comparison warnings 2021-12-21 15:30:11 +01:00
chriseth
df85d26406 Update ir-breaking-changes and make it visible. 2021-11-08 17:23:17 +01:00
Kamil Śliwak
416b13850f Sphinx extension for adding Remix links to code snippets 2021-10-07 18:25:00 +02:00
4molybdenum2
551c3ae17a Adjust Colors for the Solidity Docs 2021-10-07 16:23:30 +02:00
Kamil Śliwak
0043eca672 Consistent indentation in doc config, templates and static files 2021-10-07 16:23:27 +02:00
Kamil Śliwak
a6683e3226 Fix pylint warnings about encoding not being specified in open() calls 2021-08-23 19:24:35 +02:00
Kamil Śliwak
8c5ae508f9 Use html_extra_template_renderer to replace the current robots.txt rendering script 2021-07-15 13:29:27 +02:00
Kamil Śliwak
2bebc2f822 Create a local html_extra_template_renderer Sphinx extension 2021-07-15 13:29:27 +02:00
Kamil Śliwak
d4a86b2b10 docs/conf.py: Remove unused /utils directory from python path 2021-07-15 13:14:39 +02:00
Kamil Śliwak
570ecf1cf1 Replace deprecated Sphinx mehods with newer equivalents 2021-06-21 20:54:31 +02:00
franzihei
2962d48593 Create robots.txt
Add explanatory text
2021-04-01 16:18:46 +02:00
Alex Beregszaszi
522fdc158d Update pygments-lexer-solidity to 0.7.0 2021-03-25 20:29:05 +00:00
Djordje Mijovic
1c142c500a [Sol->Yul] Adding documentation section about breaking changes when using ir
Co-authored-by: chriseth <chris@ethereum.org>
2020-10-12 15:46:38 +02:00
Daniel Kirchner
bd21535dd1 Rewrite of the antlr grammar. 2020-08-19 17:55:31 +02:00
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