Apply theme 'books' #514

ksuess · 2021-09-02T14:36:51Z

See Sphinx "books" theme: https://sphinx-book-theme.readthedocs.io/en/latest/#

This needs

manual fixes for "books" theme

collapsed exercise solutions
:::{admonition} Solution
:class: toggle -> :class: dropdown
- :linenos: true -> :linenos:

and nice to have fixes

obsolete: intersphinx: references of docs.plone.org https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
check /about/glossary: offer two sections: Plone and Non-Plone

…re repo. WIP. - Temporarily include rst2myst/README.md in index.rst to get it to build. - Include results of initial myst2rst dry-run command to identify warnings and what needs to be fixed prior to running an actual conversion - Update conf.py to build docs from MyST syntax. - Update requirements.txt, adding myst-parser to build docs, removing alabaster theme used by advanced-python training (it actually does not use its `conf.py`), and sorting. - Add section in about_mastering about syntaxes used in documentation.

… recover Add TODOs for remaining tasks in this PR

gitignore the generated log file

Clean up and sort entries in rsync exclude files

…tion for actual run. Update results of dry-run

Add TODOs and more cleanup steps to README-convert.md

…structions for contributors)

intersphinx_mapping could be useful for references to doc.plone.org intersphinx_mapping would need some training for trainers and authors.

…aining into ksuess-theme-playground

stevepiercy

I started a review, but realized that we duplicated each other's efforts in many places, so I paused my review. My PR #515 incorporated changes from #511 and #512, and duplicate many of your changes. I think that you should rebase your branch on master after #515 is reviewed and merged to master, or you can rebase your branch on myst-convert-all now.

I will resume my review after #515 is reviewed, approved, and merged, and this branch is rebased on master.

stevepiercy · 2021-09-04T08:54:29Z

_static/custom.css

+  background-color: white;
+  box-shadow: none;
+}
+


Instead of commenting out code, either delete it or explain why it is commented. I prefer the former.

stevepiercy · 2021-09-04T08:55:11Z

_static/custom.css

@@ -1,135 +1,128 @@
+:root {
+  /* --pst-color-preformatted-background: 104, 1, 124, 0.753; */
+}


Delete entirely. Commenting the style is a no-op, and should be removed.

stevepiercy · 2021-09-04T08:56:08Z

_static/custom.css

+  /* display: block; */
+}
+ul.search .title_training::before {
+  content: ' – ';


We need consistent formatting. For CSS I prefer 2 spaces for indentation.

stevepiercy · 2021-09-04T08:57:56Z

_templates/page.html

+    //         $(this).parent().children().not(".admonition-title").toggle(400);
+    //         $(this).parent().children(".admonition-title").toggleClass("open");
+    //     })
+    // });
 </script>


Delete, don't comment out, including the outer <script> tags, because this becomes a no-op. Git history shows what used to exist, if we ever need to recover it.

stevepiercy · 2021-09-04T08:59:41Z

about/author_guide_playground.md

+you found the training team [playground](about/author_guide_playground).
+
+See foo for more info about bar.
+


What is the purpose of this file?

What is a playground?

Is this covered in other files?

stevepiercy · 2021-09-04T09:01:58Z

about/glossary.md

+ReactJS
+  A JavaScript library for building user interfaces
+
+:::


This file is superseded by PR #515. After it is merged, and after @stevepiercy moves the global glossary to docs/glossary.md, compare to see if anything was missed.

stevepiercy · 2021-09-04T09:03:33Z

about/glossary.rst

-
-   Diazo
-      `Diazo theme engine guide <http://docs.diazo.org/en/latest/>`_
-      Diazo allows you to apply a theme contained in a static HTML web page to a dynamic website created using any server-side technology.


This and all other .rst files are removed in #515. You will need to rebase on master, once that PR is merged.

stevepiercy · 2021-09-04T09:04:52Z

advanced-python/Makefile

-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)


This and all other children Makefiles are removed in #515.

You will need to rebase your branch on master after #515 is merged.

stevepiercy · 2021-09-04T09:05:09Z

advanced-python/conf.py

-]
-
-
-


This and all other children conf.pys are removed in #515

You will need to rebase your branch on master after #515 is merged.

ksuess · 2021-09-04T10:19:05Z

This PR is obsolete and will be replaced with PR based on #515

ksuess and others added 30 commits August 28, 2021 17:09

Remove individual conf.py

63d2090

conf.py vanilla

f4e3ee9

Update gulpfile.js: watch*.md

0c2d9d9

configuration: extensions of sphinx and theme 'book'

8286b4a

Create instructions.md: myst demystified

d127ebf

Update instructions.md

21cf542

Add colon_fence to myst_enable_extensions (::: instead of backticks ```)

6b7c262

Run Black

166ed59

Create logo.svg

da5700b

Theming sidebar and pre / code blocks

eced164

Add copy button for code blocks

4f1a3fc

initial commit of customized search result page

c472878

search results with training title

2fd3525

add toggle button extension

afde5d6

Update instructions.md: reference glossary terms

b4d9490

Link to plone.org in left sidebar

d5ab4d1

Update instructions.md: meta data

6889938

Add failsafe steps to prevent overwriting files and not being able to…

07a5997

… recover Add TODOs for remaining tasks in this PR

clean up search

d334dab

Make conversion as self-contained as possible.

20005e6

Add shell script for rsync, with include and exclude files for each step

fabd8be

gitignore the generated log file

Rename to a more descriptive name, as we are rsyncing the training files

396db4f

Create a shell script for dry-runs

b149599

Clean up and sort entries in rsync exclude files

Add instructions for rsynching the converted files to a nested directory

5180bca

Exclude CHANGES.rst and README.rst from conversion; remove dry-run op…

2a17076

…tion for actual run. Update results of dry-run

Fix dry-run logging filename; exclude all log files from git

6ef65e3

Don't rsync rst2myst/

2bca2b9

Don't build MyST files in nested directory

5e6d52f

Don't remove files when rsyncing *.md files

c30f191

Add TODOs and more cleanup steps to README-convert.md

stevepiercy and others added 22 commits September 1, 2021 07:42

rST syntax fixes

5358938

conf.py vanilla

fa682d0

Update gulpfile.js: watch*.md

63a8a2d

configuration: extensions of sphinx and theme 'book'

4a8ed59

Create instructions.md: myst demystified

90fa1be

Update instructions.md

7681a30

Create logo.svg

bebde67

Theming sidebar and pre / code blocks

98075f5

Add copy button for code blocks

b860ce4

initial commit of customized search result page

5726fa0

search results with training title

7d9dd6a

add toggle button extension

1b32640

Update instructions.md: reference glossary terms

e940c58

Link to plone.org in left sidebar

39f1ea2

Update instructions.md: meta data

0164eea

clean up search

45267e2

Update instructions.md

9a5a058

Update conf.py

8fd421e

Remove /about changes (see PR for about: info trainings, glossary, in…

9f6cc39

…structions for contributors)

Skip intersphinx_mapping, as it is not appied anywhere.

0bb8abd

intersphinx_mapping could be useful for references to doc.plone.org intersphinx_mapping would need some training for trainers and authors.

Create author_guide_playground.md

43209fa

Merge branch 'ksuess-theme-playground' of https://github.com/plone/tr…

4b1e0de

…aining into ksuess-theme-playground

ksuess requested review from spereverde and stevepiercy September 2, 2021 14:36

ksuess added this to the Relaunch milestone Sep 2, 2021

stevepiercy mentioned this pull request Sep 3, 2021

Relaunch training.plone.org #506

Closed

37 tasks

stevepiercy requested changes Sep 4, 2021

View reviewed changes

ksuess closed this Sep 4, 2021

ksuess deleted the ksuess-theme-playground branch September 10, 2021 16:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Apply theme 'books' #514

Apply theme 'books' #514

ksuess commented Sep 2, 2021

stevepiercy left a comment •

edited

Loading

stevepiercy Sep 4, 2021

stevepiercy Sep 4, 2021

stevepiercy Sep 4, 2021

stevepiercy Sep 4, 2021

stevepiercy Sep 4, 2021

stevepiercy Sep 4, 2021 •

edited

Loading

stevepiercy Sep 4, 2021 •

edited

Loading

stevepiercy Sep 4, 2021 •

edited

Loading

stevepiercy Sep 4, 2021 •

edited

Loading

ksuess commented Sep 4, 2021

		you found the training team [playground](about/author_guide_playground).

		See foo for more info about bar.

Apply theme 'books' #514

Apply theme 'books' #514

Conversation

ksuess commented Sep 2, 2021

stevepiercy left a comment • edited Loading

Choose a reason for hiding this comment

stevepiercy Sep 4, 2021

Choose a reason for hiding this comment

stevepiercy Sep 4, 2021

Choose a reason for hiding this comment

stevepiercy Sep 4, 2021

Choose a reason for hiding this comment

stevepiercy Sep 4, 2021

Choose a reason for hiding this comment

stevepiercy Sep 4, 2021

Choose a reason for hiding this comment

stevepiercy Sep 4, 2021 • edited Loading

Choose a reason for hiding this comment

stevepiercy Sep 4, 2021 • edited Loading

Choose a reason for hiding this comment

stevepiercy Sep 4, 2021 • edited Loading

Choose a reason for hiding this comment

stevepiercy Sep 4, 2021 • edited Loading

Choose a reason for hiding this comment

ksuess commented Sep 4, 2021

stevepiercy left a comment •

edited

Loading

stevepiercy Sep 4, 2021 •

edited

Loading

stevepiercy Sep 4, 2021 •

edited

Loading

stevepiercy Sep 4, 2021 •

edited

Loading

stevepiercy Sep 4, 2021 •

edited

Loading