Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs sphinx 4 upgrade #2666

Merged
merged 11 commits into from
Oct 5, 2021
Merged

Docs sphinx 4 upgrade #2666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
91eb974
Removed CSS rules for highlighttable elements
Grimmys Aug 6, 2021
2370840
Added CSS rules to fix the rendering of an image next to its code block
Grimmys Aug 7, 2021
34fb2fb
Let the images that should be displayed next to a codeblock be displa…
Grimmys Aug 7, 2021
f3be2c7
Added space between line number and statement in codeblocks
Grimmys Aug 8, 2021
f5f1eaf
Modified CSS rules to prevent text overflow on small screens
Grimmys Aug 8, 2021
e72ca63
Break lines in pre blocks on mobile devices only
Grimmys Aug 29, 2021
5f03374
Revert td width back to 200% but not for mobile devices
Grimmys Aug 29, 2021
1623db4
Removed empty block line between "Raises" and "Note" blocks on scrap …
Grimmys Sep 5, 2021
ec24266
Merge branch 'pygame:main' into docs-sphinx-4-upgrade
Grimmys Sep 23, 2021
e806775
Added new CSS rule to embrace most recent docutils tag generation
Grimmys Sep 26, 2021
b576d34
Added extra blank line at the end of pygame.css_t file
Grimmys Sep 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/reST/ref/scrap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@ For an example of how the scrap module works refer to the examples page

:raises pygame.error: if unable to initialize scrap module

|

.. note:: The scrap module requires :func:`pygame.display.set_mode()` be
called before being initialized.

Expand Down
78 changes: 45 additions & 33 deletions docs/reST/themes/classic/static/pygame.css_t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,7 @@ div.body table.matrix th.stub {

/* Let a float element be beside a code block */
div.highlight-python.notranslate {
margin: 0;
clear: none;
display: inline-block;
}

/* -- page layout ----------------------------------------------------------- */
Expand Down Expand Up @@ -147,13 +146,6 @@ div.document {
}
}

/* Make tables be responsive-ish. */
@media only screen and (max-width: 680px) {
table, thead, tbody, th, td, tr {
display: block;
}
}

.toc td {
display:block;
width: 200%;
Expand Down Expand Up @@ -485,28 +477,13 @@ pre {
line-height: 120%;
margin-bottom: 1em;
padding: 5px 5px 5px 15px;
text-align: justify;
}

div.highlight pre {
border: none;
}

table.highlighttable {
display: table;
}

@media only screen and (max-width: 680px) {
table.highlighttable {
display: block;
}
}

table.highlighttable,
table.highlighttable pre {
border: none;
background-color: #eeffcc;
}

ul.simple {
list-style-type: circle;
margin-bottom: 1em;
Expand All @@ -517,8 +494,12 @@ code.descclassname, code.descname {
font-weight: bold;
}

/* Top level section title format */
div.body > div.section > dl > dt.title {
/*
Top level section title format
section tag has been introduced in docutils 0.17 as a replacement for div.section
Both rule variations are kept to support old versions of docutils
*/
div.body > section > dl > dt.title, div.body > div.section > dl > dt.title {
font-size: 120%;
font-weight: bold;
margin-bottom: 1em;
Expand Down Expand Up @@ -575,6 +556,7 @@ div.body p.small-heading {
div.body div.inlined,
div.body img.inlined-right {
float: right;
margin: 1em 0;
}

div.body .inset {
Expand All @@ -593,6 +575,10 @@ div.body span.codelineref {
background-color: {{ theme_keywordbgcolor }};
}

span.linenos {
margin-right: 15px;
}

/* Examples section: contains one or more example subsections */
div.examples > div.example {
clear: both;
Expand All @@ -618,12 +604,6 @@ div.example div.break {
height: 0;
}

/* -- parameters returns table style ---------------------------------------- */

dl.field-list > dt {
padding-right: 10px;
}

/* -- tooltip style --------------------------------------------------------- */

a.tooltip {
Expand Down Expand Up @@ -689,3 +669,35 @@ pre.commentContent {
border: 0;
white-space: pre-wrap;
}

/* -- responsive design --------------------------------------------------------- */

@media only screen and (max-width: 680px) {
/* Make tables be responsive-ish. */
table, thead, tbody, th, td, tr {
display: block;
}

div.body img.inlined-right {
float: none;
display: block;
margin: auto
}

span.linenos {
margin-right: 10px;
}

.addcomment input, a.commentButton {
font-size: 10px;
}

pre {
white-space: pre-wrap;
word-wrap: break-word;
}

.toc td {
width: 100%;
}
}