rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-21 01:39:07 +02:00
Code Issues Releases Activity
dc4a1eb53b
comprehensive-rust/book.toml

241 lines
12 KiB
TOML
Raw Normal View History

Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
[book]
authors = ["Martin Geisler"]
language = "en"
multilingual = false
src = "src"
title = "Comprehensive Rust 🦀"
[rust]
edition = "2021"
Watch `po/` directory for changes (#188) This makes `mdbook serve` automatically reload the page when translations change.
2023-01-20 12:36:14 +02:00
[build]
Integrate GA4 code directly with `book.js` (#470) * Integrate GA4 code directly with `book.js` The main advantage of this is that it simplifies the setup since we can avoid the monkey-patching we did before. A secondary advantage is that it should make things a little faster since we avoid a request to the server on every page load. * Remove unreachable return * Watch all of `third_party` It just occurred to me that we want to refresh the page in `mdbook serve` when anything changes in `third_party`.
2023-03-02 19:50:37 +02:00
extra-watch-dirs = ["po", "third_party"]
Watch `po/` directory for changes (#188) This makes `mdbook serve` automatically reload the page when translations change.
2023-01-20 12:36:14 +02:00
Make `i18n-helpers` a requirement (#461) * Make i18n-helpers a requirement * Skip mdbook-gettext for mdbook-xgettext * Gettext finds PO file based on `book.language` * Update workflow No need to set `preprocessor.gettext.po-file`. --------- Co-authored-by: Jooyung Han <jooyung@google.com>
2023-02-28 15:05:09 +02:00
[preprocessor.gettext]
Remove `renderers` from `links` and `index` preprocessors (#464) * Remove `renderers` from `links` and `index` preprocessors These two preprocessors are default preprocessors and controlled by `build.use_default_preprocessors` not by `renders`. * Fix the order of preprocessors I was wrong about the order in #461. * Remove `links` and `index` preprocessor lines These default preprocessors are run by default. --------- Co-authored-by: Jooyung Han <jooyung@google.com>
2023-03-02 11:01:24 +02:00
after = ["links"]
Add support for translations This implements a translation pipeline using the industry-standard Gettext[1] system. I picked Gettext for the reasons described in [2] and [3]: * It’s widely used in open source software. This means that there are graphical editors which will help you in editing the `.po` files. An example is Poedit[4], which is available for all major platforms. There are also many online systems for doing translations. An example is Pontoon[5], which is used for the Rust website itself. We can consider setting up such an instance ourselves. * It is a light-weight yet structured format. This means that nothing changes with regards to how you update the original English text. We can still accept fixes and PRs like normal. The structure means that translators can see exactly which part of the course they need to update after a change. This is completely lost if you simply copy over the original text and translate it in-place in the Markdown files. The code here only adds support for translations. They are not yet tested, published or used for anything. Next steps will be: * Add support for switching languages via a bit of JavaScript on each page. * Update the speaker notes feature to support translations (right now “Speaker Notes” is hard-coded into the generated HTML). I think we should turn it into a mdbook preprocessor instead. * Add testing: We should test that the `.po` files are well-formed. We should also run `mdbook test` on each language since the translations can alter the embedded code. Fixes #115. [1]: https://www.gnu.org/software/gettext/manual/html_node/index.html [2]: https://github.com/rust-lang/mdBook/pull/1864 [3]: https://github.com/rust-lang/mdBook/issues/5#issuecomment-1144887806 [4]: https://poedit.net/ [5]: https://pontoon.rust-lang.org/
2023-01-08 14:45:19 +02:00
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
[preprocessor.svgbob]
Add support for translations This implements a translation pipeline using the industry-standard Gettext[1] system. I picked Gettext for the reasons described in [2] and [3]: * It’s widely used in open source software. This means that there are graphical editors which will help you in editing the `.po` files. An example is Poedit[4], which is available for all major platforms. There are also many online systems for doing translations. An example is Pontoon[5], which is used for the Rust website itself. We can consider setting up such an instance ourselves. * It is a light-weight yet structured format. This means that nothing changes with regards to how you update the original English text. We can still accept fixes and PRs like normal. The structure means that translators can see exactly which part of the course they need to update after a change. This is completely lost if you simply copy over the original text and translate it in-place in the Markdown files. The code here only adds support for translations. They are not yet tested, published or used for anything. Next steps will be: * Add support for switching languages via a bit of JavaScript on each page. * Update the speaker notes feature to support translations (right now “Speaker Notes” is hard-coded into the generated HTML). I think we should turn it into a mdbook preprocessor instead. * Add testing: We should test that the `.po` files are well-formed. We should also run `mdbook test` on each language since the translations can alter the embedded code. Fixes #115. [1]: https://www.gnu.org/software/gettext/manual/html_node/index.html [2]: https://github.com/rust-lang/mdBook/pull/1864 [3]: https://github.com/rust-lang/mdBook/issues/5#issuecomment-1144887806 [4]: https://poedit.net/ [5]: https://pontoon.rust-lang.org/
2023-01-08 14:45:19 +02:00
renderers = ["html"]
Remove `renderers` from `links` and `index` preprocessors (#464) * Remove `renderers` from `links` and `index` preprocessors These two preprocessors are default preprocessors and controlled by `build.use_default_preprocessors` not by `renders`. * Fix the order of preprocessors I was wrong about the order in #461. * Remove `links` and `index` preprocessor lines These default preprocessors are run by default. --------- Co-authored-by: Jooyung Han <jooyung@google.com>
2023-03-02 11:01:24 +02:00
after = ["gettext"]
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
class = "bob"
Add mdbook-course to handle parsing frontmatter (#1224) In v2 of the course, I'd like to include an estimate of the time to be spent on each segment in the Markdown file. I think a good place for such metadata is in the frontmatter. For review purposes, though, I just want to display that information. So, this is a start at a new mdbook preprocessor that just separates out the frontmatter and includes it in a `<pre>` block. Eventually, I'd like to parse it and put the time in the speaker notes. --------- Co-authored-by: Martin Geisler <martin@geisler.net>
2023-09-20 16:01:53 +02:00
[preprocessor.course]
mdbook-course: Make printing summary optional (#1562) There is now a new “verbose” setting which can be used to print the summary when desired.
2023-12-06 19:57:18 +02:00
verbose = false # Report timing information.
Add an aspect-ratio-helper mdbook preprocessor (#187) The idea is that this will help us make better slides: we can see at a glance when the slide becomes too full.
2023-01-27 19:30:37 +02:00
# Enable this preprocessor to overlay a large red rectangle on the
# pages. This will show you an estimate of what the course
# participants can see during the presentation.
#
# [preprocessor.aspect-ratio-helper]
# command = "./aspect-ratio-helper.py"
Render book as PDF in `publish.yml` workflow (#1572) Renders the book as a PDF and includes it in the published HTML bundle as `comprehensive-rust.pdf`. Closes #1543
2024-01-16 00:02:05 +02:00
[output.pandoc]
optional = true
Rendered PDF improvements (#1805) Updates `mdbook-pandoc` to [0.5.0](https://github.com/max-heller/mdbook-pandoc/releases/tag/v0.5.0) to use some new features: - Table wrapping (closes #1709) The wrapping logic mirror's [Pandoc's](https://pandoc.org/MANUAL.html#extension-pipe_tables) (i.e., compare the relative widths of the `---` columns to determine column widths) so tables in the source may need tweaking to get the proportions right - Replace broken links in PDF with corresponding links to https://google.github.io/comprehensive-rust/
2024-02-20 12:04:30 +02:00
hosted-html = "https://google.github.io/comprehensive-rust/"
Render book as PDF in `publish.yml` workflow (#1572) Renders the book as a PDF and includes it in the published HTML bundle as `comprehensive-rust.pdf`. Closes #1543
2024-01-16 00:02:05 +02:00
[output.pandoc.profile.pdf]
output-file = "comprehensive-rust.pdf"
pdf-engine = "lualatex"
[output.pandoc.profile.pdf.variables]
mainfont = "Noto Serif"
sansfont = "Noto Sans"
monofont = "Noto Sans Mono"
geometry = ["margin=1.25in"]
linkcolor = "blue"
urlcolor = "red"
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
[output.html]
curly-quotes = true
Move CSS files into `theme/` folder (#1229) Hi all, This PR fixes https://github.com/google/comprehensive-rust/issues/1226: * Moved CSS files to `theme/css` * Moved speaker-notes.js to `theme/` * Updated paths in book.toml
2023-09-21 11:00:27 +02:00
additional-js = ["theme/speaker-notes.js"]
Add mdbook-course to handle parsing frontmatter (#1224) In v2 of the course, I'd like to include an estimate of the time to be spent on each segment in the Markdown file. I think a good place for such metadata is in the frontmatter. For review purposes, though, I just want to display that information. So, this is a start at a new mdbook preprocessor that just separates out the frontmatter and includes it in a `<pre>` block. Eventually, I'd like to parse it and put the time in the speaker notes. --------- Co-authored-by: Martin Geisler <martin@geisler.net>
2023-09-20 16:01:53 +02:00
additional-css = [
Move CSS files into `theme/` folder (#1229) Hi all, This PR fixes https://github.com/google/comprehensive-rust/issues/1226: * Moved CSS files to `theme/css` * Moved speaker-notes.js to `theme/` * Updated paths in book.toml
2023-09-21 11:00:27 +02:00
"theme/css/svgbob.css",
"theme/css/speaker-notes.css",
"theme/css/language-picker.css",
Fixture code and footer content tags in rtl content (#1433) Part of #671 and #1413 In the code part of content which always is in english and must be `text-align: left` but with `<html ... dir=rtl >` cuz conflict. --------- Co-authored-by: Kaveh <hamidrkp@riseup.net>
2023-10-31 08:37:04 +02:00
"theme/css/rtl.css",
Add mdbook-course to handle parsing frontmatter (#1224) In v2 of the course, I'd like to include an estimate of the time to be spent on each segment in the Markdown file. I think a good place for such metadata is in the frontmatter. For review purposes, though, I just want to display that information. So, this is a start at a new mdbook preprocessor that just separates out the frontmatter and includes it in a `<pre>` block. Eventually, I'd like to parse it and put the time in the speaker notes. --------- Co-authored-by: Martin Geisler <martin@geisler.net>
2023-09-20 16:01:53 +02:00
]
Set the site-url to fix 404 page on GitHub Pages (#263) This fixes the 404 page on GitHub Pages: the default is `/`, but we’re hosting the site from a subdirectory because of how the repository is setup. Fixes #178.
2023-01-24 13:03:46 +02:00
site-url = "/comprehensive-rust/"
Link back to repository in top-right corner
2022-12-21 18:28:02 +02:00
git-repository-url = "https://github.com/google/comprehensive-rust"
Add links to edit every page on GitHub This makes it super easy to edit a page: just click the icon in the top-right and you’ll be taken directly to an editor on GitHub.
2022-12-21 18:29:56 +02:00
edit-url-template = "https://github.com/google/comprehensive-rust/edit/main/{path}"
Publish Comprehensive Rust 🦀
2022-12-21 17:36:30 +02:00
[output.html.fold]
enable = true
level = 0
[output.html.playground]
editable = true
Display line numbers for code examples (#664) This makes it easier to refer to a specific line of code while teaching or collaborating on a code snippet.
2023-05-24 09:25:18 +02:00
line-numbers = true
Setup redirects after #120 and #177 (#352) This makes `mdbook` output a simple redirect at the location of the old pages. I’ll try to add such pages when we shuffle around our pages to make sure external links stay valid.
2023-02-06 18:10:01 +02:00
Fix `mdbook` redirection table (#1567) There must have been a merge conflict at some point which resulted in a malformed table. The result was that most redirects were blindly ignored by `mdbook`. I noticed it for https://google.github.io/comprehensive-rust/enums.html which stopped working because of this. I took out the memory management redirect since we already have a file where redirect would be (`mdbook` helpfully emits an error in this case).
2023-12-07 17:51:42 +02:00
[output.html.search]
use-boolean-and = true
Setup redirects after #120 and #177 (#352) This makes `mdbook` output a simple redirect at the location of the old pages. I’ll try to add such pages when we shuffle around our pages to make sure external links stay valid.
2023-02-06 18:10:01 +02:00
[output.html.redirect]
Cleanup references to "Day 4" (#603) * Align outline with new spin-off course structure With the new structure, the section on Android is a spin-off course from the main 3-day course on Rust Fundamentals. The Bare-metal and Concurrency days are spin-off courses in the same way. * Explain new course structure * Align Bare-Metal welcome page with other deep dives * Merge Day 4 page into Course Structure page * Remove Day 4 Welcome page This aligns the Concurrency in Rust section with the Bare-Metal Rust deep dive. * Show subsections for Android deep dive This aligns the Rust in Android section with the other deep dives. * Clean up welcome page and README We now cover async Rust and the course is no longer a four day course. * Remove reference to the old Day 4 * Remove Day 4 references from exercises
2023-05-02 08:02:28 +02:00
# Redirects in the form of "old-path" = "new-path", where the new path
# is relative to the old path.
Add redirect for old async/concurrency/ directory (#635) It seems we had a link to async/concurrency/channels.html for a brief period. This got indexed and now show up as 404 errors in my reports.
2023-05-15 16:05:28 +02:00
"async/concurrency/channels.html" = "../channels.html"
Fix broken link in Pitfalls of `async`/`await` (#811) Fix broken link in Async Pitfalls
2023-06-13 19:26:56 +02:00
"async/pitfall/async-traits.html" = "../pitfalls/async-traits.html"
Fix broken link in for-expressions.md (#812)
2023-06-13 19:43:08 +02:00
"control-flow/while-let-expression.html" = "while-let-expressions.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"exercises/day-1/soluções-tarde.html" = "solutions-afternoon.html"
"exercises/day-2/soluções-tarde.html" = "solutions-afternoon.html"
"exercises/day-3/soluções-tarde.html" = "solutions-afternoon.html"
"exercises/day-3/simples-gui.html" = "simple-gui.html"
Fix page redirects (#620) * Fix broken redirects A few of these were wrong since they assumed the target path is relative to the root of the course (the path is relative to the page being redirected). * Sort redirects
2023-05-08 16:31:54 +02:00
"exercises/day-4/afternoon.html" = "../android/morning.html"
"exercises/day-4/android.html" = "../android/morning.html"
"exercises/day-4/dining-philosophers.html" = "../concurrency/dining-philosophers.html"
"exercises/day-4/elevator.html" = "../concurrency/elevator.html"
"exercises/day-4/link-checker.html" = "../concurrency/link-checker.html"
"exercises/day-4/morning.html" = "../concurrency/morning.html"
"exercises/day-4/solutions-morning.html" = "../concurrency/solutions-morning.html"
Add the description of the chat-app exercise (#641) * Adds a description of the async chat exercise * Simplifies the use of Error in chat-async * Links the solution to the async chat exercise * Removes the elevator exercise
2023-05-17 19:22:11 +02:00
"exercises/concurrency/elevator.html" = "chat-app.html"
Fix page redirects (#620) * Fix broken redirects A few of these were wrong since they assumed the target path is relative to the root of the course (the path is relative to the page being redirected). * Sort redirects
2023-05-08 16:31:54 +02:00
"generics/closures.html" = "../traits/closures.html"
Fix broken link to trait objects (#633)
2023-05-15 16:06:50 +02:00
"generics/trait-objects.html" = "../traits/trait-objects.html"
fix mdbook redirection table (#1635) Link `overloading` in Speaker note in URL: https://google.github.io/comprehensive-rust/hello-world/hello-world.html is broken. - broken: https://google.github.io/comprehensive-rust/hello-world/basic-syntax/functions-interlude.html (404) - correct: https://google.github.io/comprehensive-rust/control-flow-basics/functions.html The reason why it is broken is below. Original markdown is here https://github.com/google/comprehensive-rust/blob/43474d27d1276e8a88307a1686ee3f36cd77cf7f/src/hello-world/hello-world.md?plain=1#L36-L37 ``` [overloading](basic-syntax/functions-interlude.md) ``` Page path is `/hello-world/hello-world.html`, so overloading link become `/hello-world/basic-syntax/functions-interlude.html`, which is 404. I feel it is better to use redirect to exact path, so I edit `book.toml` and make link redirect to `/basic-syntax/functions-interlude.html`, which re-redirect to path `/control-flow-basics/functions.html` https://github.com/google/comprehensive-rust/blob/43474d27d1276e8a88307a1686ee3f36cd77cf7f/book.toml#L114
2024-01-04 16:05:49 +02:00
"hello-world/basic-syntax/functions-interlude.html" = "../../control-flow-basics/functions.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"outros-recursos.html" = "other-resources.html"
Cleanup references to "Day 4" (#603) * Align outline with new spin-off course structure With the new structure, the section on Android is a spin-off course from the main 3-day course on Rust Fundamentals. The Bare-metal and Concurrency days are spin-off courses in the same way. * Explain new course structure * Align Bare-Metal welcome page with other deep dives * Merge Day 4 page into Course Structure page * Remove Day 4 Welcome page This aligns the Concurrency in Rust section with the Bare-Metal Rust deep dive. * Show subsections for Android deep dive This aligns the Rust in Android section with the other deep dives. * Clean up welcome page and README We now cover async Rust and the course is no longer a four day course. * Remove reference to the old Day 4 * Remove Day 4 references from exercises
2023-05-02 08:02:28 +02:00
"running-the-course/day-4.html" = "course-structure.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"sintaxe-básica/funções-interlude.html" = "../basic-syntax/functions-interlude.html"
Fix page redirects (#620) * Fix broken redirects A few of these were wrong since they assumed the target path is relative to the root of the course (the path is relative to the page being redirected). * Sort redirects
2023-05-08 16:31:54 +02:00
"structure.html" = "running-the-course/course-structure.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"unsafe/mutable-static-variables.md" = "mutable-static-variables.html"
Setup redirects after #120 and #177 (#352) This makes `mdbook` output a simple redirect at the location of the old pages. I’ll try to add such pages when we shuffle around our pages to make sure external links stay valid.
2023-02-06 18:10:01 +02:00
"unsafe/unsafe-functions.html" = "calling-unsafe-functions.html"
Cleanup references to "Day 4" (#603) * Align outline with new spin-off course structure With the new structure, the section on Android is a spin-off course from the main 3-day course on Rust Fundamentals. The Bare-metal and Concurrency days are spin-off courses in the same way. * Explain new course structure * Align Bare-Metal welcome page with other deep dives * Merge Day 4 page into Course Structure page * Remove Day 4 Welcome page This aligns the Concurrency in Rust section with the Bare-Metal Rust deep dive. * Show subsections for Android deep dive This aligns the Rust in Android section with the other deep dives. * Clean up welcome page and README We now cover async Rust and the course is no longer a four day course. * Remove reference to the old Day 4 * Remove Day 4 references from exercises
2023-05-02 08:02:28 +02:00
"welcome-bare-metal.html" = "bare-metal.html"
Reorder material on first two days (#913) - Morning of Day 1 still introduces the language and its high-level goals/value proposition, and starts with the built-in data types Rust provides, and how you define a function. - Afternoon of Day 1 gets a front loading of the basic control flow structures in Rust but not the more exotic ones. - The exercises for day 1 afternoon will be the Luhn algorithm (where we can match on digits and enums such as `Option`. - Morning of day 2 still has discussion of memory management. Fixes #510. --------- Co-authored-by: Martin Geisler <mgeisler@google.com>
2023-08-25 17:42:31 +02:00
# Moving exercises between days
"exercises/day-2/luhn.html" = "../day-1/luhn.html"
"exercises/day-2/points-polygons.html" = "../day-3/points-polygons.html"
"exercises/day-1/book-library.html" = "../day-2/book-library.html"
"exercises/day-1/iterators-and-ownership.html" = "../day-2/iterators-and-ownership.html"
Rename `welcome.md` to `index.md` (#1039) When building the book, mdBook will always generate an `index.html` page for first page of the book. This meant that we had the same content available under two different names: - `welcome.html`: this is what the TOC would link to, and - `index.html` or simply `/`: this is what search engines link to Renaming the page and setting up a redirect should fix this confusion. We still don’t have a good way of avoiding links to the `index.html` page, but this should fix the first half of the problem. I tested this for translations as well by building the output in a subdirectory and serving the parent directory. Part of #847.
2023-07-28 17:27:31 +02:00
# Send people to canonical URL instead of index.html
"welcome.html" = "./"
Run exerciser as mdbook renderer.
2023-04-03 17:18:32 +02:00
Comprehensive Rust v2 (#1073) I've taken some work by @fw-immunant and others on the new organization of the course and condensed it into a form amenable to a text editor and some computational analysis. You can see the inputs in `course.py` but the interesting bits are the output: `outline.md` and `slides.md`. The idea is to break the course into more, smaller segments with exercises at the ends and breaks in between. So `outline.md` lists the segments, their duration, and sums those durations up per-day. It shows we're about an hour too long right now! There are more details of the segments in `slides.md`, or you can see mostly the same stuff in `course.py`. This now contains all of the content from the v1 course, ensuring both that we've covered everything and that we'll have somewhere to redirect every page. Fixes #1082. Fixes #1465. --------- Co-authored-by: Nicole LeGare <dlegare.1001@gmail.com> Co-authored-by: Martin Geisler <mgeisler@google.com>
2023-11-29 17:39:24 +02:00
# redirects from course v1 to v2
'welcome-day-1/what-is-rust.html' = '../hello-world/what-is-rust.html'
'hello-world/small-example.html' = '../hello-world/hello-world.html'
'why-rust.html' = 'hello-world/benefits.html'
'why-rust/compile-time.html' = '../hello-world/benefits.html'
'why-rust/runtime.html' = '../hello-world/benefits.html'
'why-rust/modern.html' = '../hello-world/benefits.html'
'why-rust/an-example-in-c.html' = '../hello-world/example.html'
'basic-syntax/variables.html' = '../types-and-values/variables.html'
'basic-syntax/scalar-types.html' = '../types-and-values/values.html'
'basic-syntax/type-inference.html' = '../types-and-values/inference.html'
'basic-syntax.html' = 'control-flow-basics.html'
'control-flow.html' = 'control-flow-basics.html'
'control-flow/if-expressions.html' = '../control-flow-basics/conditionals.html'
'control-flow/while-expressions.html' = '../control-flow-basics/loops.html'
'control-flow/for-expressions.html' = '../control-flow-basics/loops.html'
'control-flow/break-continue.html' = '../control-flow-basics/break-continue.html'
'control-flow/loop-expressions.html' = '../control-flow-basics/loops.html'
'basic-syntax/scopes-shadowing.html' = '../control-flow-basics/blocks-and-scopes.html'
'control-flow/blocks.html' = '../control-flow-basics/blocks-and-scopes.html'
'basic-syntax/functions.html' = '../control-flow-basics/functions.html'
'basic-syntax/rustdoc.html' = '../std-types/docs.html'
'basic-syntax/methods.html' = '../control-flow-basics/functions.html'
'basic-syntax/functions-interlude.html' = '../control-flow-basics/functions.html'
'exercises/day-1/morning.html' = '../../control-flow-basics/exercise.html'
'exercises/day-1/afternoon.html' = '../../control-flow-basics/exercise.html'
'exercises/day-2/morning.html' = '../../control-flow-basics/exercise.html'
'exercises/day-2/afternoon.html' = '../../control-flow-basics/exercise.html'
'exercises/day-3/morning.html' = '../../control-flow-basics/exercise.html'
'exercises/day-3/afternoon.html' = '../../control-flow-basics/exercise.html'
'basic-syntax/compound-types.html' = '../tuples-and-arrays/tuples-and-arrays.html'
'control-flow/match-expressions.html' = '../tuples-and-arrays/match.html'
'pattern-matching/match-guards.html' = '../tuples-and-arrays/match.html'
'pattern-matching/destructuring-arrays.html' = '../tuples-and-arrays/destructuring.html'
'exercises/day-1/for-loops.html' = '../../tuples-and-arrays/exercise.html'
'basic-syntax/references.html' = '../references/shared.html'
'basic-syntax/references-dangling.html' = '../references/shared.html'
'exercises/day-3/points-polygons.html' = '../../references/exercise.html'
'structs.html' = 'user-defined-types/named-structs.html'
'structs/field-shorthand.html' = '../user-defined-types/named-structs.html'
'structs/tuple-structs.html' = '../user-defined-types/tuple-structs.html'
'enums.html' = 'user-defined-types/enums.html'
'enums/variant-payloads.html' = '../user-defined-types/enums.html'
'enums/sizes.html' = '../user-defined-types/enums.html'
'traits/deriving-traits.html' = '../methods-and-traits/deriving.html'
'pattern-matching/destructuring-structs.html' = '../pattern-matching/destructuring.html'
'pattern-matching/destructuring-enums.html' = '../pattern-matching/destructuring.html'
'control-flow/novel.html' = '../pattern-matching/let-control-flow.html'
'control-flow/if-let-expressions.html' = '../pattern-matching/let-control-flow.html'
'control-flow/while-let-expressions.html' = '../pattern-matching/let-control-flow.html'
'exercises/day-1/pattern-matching.html' = '../../user-defined-types/exercise.html'
'methods.html' = 'methods-and-traits/methods.html'
'methods/receiver.html' = '../methods-and-traits/methods.html'
'methods/example.html' = '../methods-and-traits/methods.html'
'traits.html' = 'methods-and-traits/traits.html'
'traits/default-methods.html' = '../methods-and-traits/traits.html'
Move Trait Objects to the Smart Pointers segment (#1756) Fixes #1516.
2024-01-25 16:47:50 +02:00
'methods-and-traits/trait-objects.html' = '../smart-pointers/trait-objects.html'
'traits/trait-objects.html' = '../smart-pointers/trait-objects.html'
Comprehensive Rust v2 (#1073) I've taken some work by @fw-immunant and others on the new organization of the course and condensed it into a form amenable to a text editor and some computational analysis. You can see the inputs in `course.py` but the interesting bits are the output: `outline.md` and `slides.md`. The idea is to break the course into more, smaller segments with exercises at the ends and breaks in between. So `outline.md` lists the segments, their duration, and sums those durations up per-day. It shows we're about an hour too long right now! There are more details of the segments in `slides.md`, or you can see mostly the same stuff in `course.py`. This now contains all of the content from the v1 course, ensuring both that we've covered everything and that we'll have somewhere to redirect every page. Fixes #1082. Fixes #1465. --------- Co-authored-by: Nicole LeGare <dlegare.1001@gmail.com> Co-authored-by: Martin Geisler <mgeisler@google.com>
2023-11-29 17:39:24 +02:00
'exercises/day-3/simple-gui.html' = '../../methods-and-traits/exercise.html'
'generics/monomorphization.html' = '../generics/generic-functions.html'
'generics/data-types.html' = '../generics/generic-data.html'
'generics/methods.html' = '../generics/generic-data.html'
'traits/trait-bounds.html' = '../generics/trait-bounds.html'
'traits/impl-trait.html' = '../generics/impl-trait.html'
'std.html' = 'std-types/std.html'
'std/option-result.html' = '../std-types/option.html'
'error-handling/result.html' = '../std-types/result.html'
'std/string.html' = '../std-types/string.html'
'std/vec.html' = '../std-types/vec.html'
'std/hashmap.html' = '../std-types/hashmap.html'
'exercises/day-2/book-library.html' = '../../std-types/exercise.html'
'traits/important-traits.html' = '../std-traits/comparisons.html'
'traits/operators.html' = '../std-traits/operators.html'
'traits/from-into.html' = '../std-traits/from-and-into.html'
'traits/read-write.html' = '../std-traits/read-and-write.html'
'traits/default.html' = '../std-traits/default.html'
'traits/closures.html' = '../std-traits/closures.html'
'exercises/day-1/implicit-conversions.html' = '../../std-traits/exercise.html'
'traits/iterator.html' = '../iterators/iterators.html'
'exercises/day-2/iterators-and-ownership.html' = '../../iterators/intoiterator.html'
'traits/from-iterator.html' = '../iterators/fromiterator.html'
'exercises/day-2/strings-iterators.html' = '../../iterators/exercise.html'
'testing/integration-tests.html' = '../testing/other.html'
'testing/doc-tests.html' = '../testing/other.html'
'exercises/day-1/luhn.html' = '../../testing/exercise.html'
'memory-management/stack-vs-heap.html' = '../memory-management/review.html'
'memory-management/stack.html' = '../memory-management/review.html'
'memory-management/manual.html' = '../memory-management/approaches.html'
'memory-management/scope-based.html' = '../memory-management/approaches.html'
'memory-management/garbage-collection.html' = '../memory-management/approaches.html'
'ownership.html' = 'memory-management/ownership.html'
'memory-management/rust.html' = '../memory-management/ownership.html'
'ownership/move-semantics.html' = '../memory-management/move.html'
'ownership/moved-strings-rust.html' = '../memory-management/move.html'
'ownership/double-free-modern-cpp.html' = '../memory-management/move.html'
'ownership/moves-function-calls.html' = '../memory-management/move.html'
'ownership/copy-clone.html' = '../memory-management/copy-types.html'
'traits/drop.html' = '../memory-management/drop.html'
'std/box.html' = '../smart-pointers/box.html'
'std/box-recursive.html' = '../smart-pointers/box.html'
'std/box-niche.html' = '../smart-pointers/box.html'
'std/rc.html' = '../smart-pointers/rc.html'
'ownership/borrowing.html' = '../borrowing/shared.html'
'ownership/shared-unique-borrows.html' = '../borrowing/shared.html'
'std/cell.html' = '../borrowing/interior-mutability.html'
'exercises/day-2/health-statistics.html' = '../../borrowing/exercise.html'
'error-handling/panic-unwind.html' = '../error-handling/panics.html'
'error-handling/try-operator.html' = '../error-handling/try.html'
'error-handling/converting-error-types.html' = '../error-handling/try-conversions.html'
'error-handling/converting-error-types-example.html' = '../error-handling/try-conversions.html'
'error-handling/deriving-error-enums.html' = '../error-handling/error.html'
'error-handling/error-contexts.html' = '../error-handling/thiserror-and-anyhow.html'
'error-handling/dynamic-errors.html' = '../error-handling/thiserror-and-anyhow.html'
'basic-syntax/slices.html' = '../slices-and-lifetimes/slices.html'
'basic-syntax/string-slices.html' = '../slices-and-lifetimes/str.html'
'ownership/lifetimes.html' = '../slices-and-lifetimes/lifetime-annotations.html'
'ownership/lifetimes-function-calls.html' = '../slices-and-lifetimes/lifetime-elision.html'
'ownership/lifetimes-data-structures.html' = '../slices-and-lifetimes/struct-lifetimes.html'
'unsafe.html' = 'unsafe-rust/unsafe.html'
'unsafe/raw-pointers.html' = '../unsafe-rust/dereferencing.html'
'basic-syntax/static-and-const.html' = '../unsafe-rust/static-and-const.html'
'unsafe/mutable-static-variables.html' = '../unsafe-rust/mutable-static.html'
'unsafe/unions.html' = '../unsafe-rust/unions.html'
'unsafe/calling-unsafe-functions.html' = '../unsafe-rust/unsafe-functions.html'
'unsafe/writing-unsafe-functions.html' = '../unsafe-rust/unsafe-functions.html'
'unsafe/extern-functions.html' = '../unsafe-rust/unsafe-functions.html'
'unsafe/unsafe-traits.html' = '../unsafe-rust/unsafe-traits.html'
'exercises/day-3/safe-ffi-wrapper.html' = '../../unsafe-rust/exercise.html'
Remove tangential text from `if` slide (#1840)
2024-02-23 18:53:26 +02:00
'hello-world/hello-world.html' = '../types-and-values/hello-world.html'
'control-flow-basics/conditionals.html' = 'if.html'
Comprehensive Rust v2 (#1073) I've taken some work by @fw-immunant and others on the new organization of the course and condensed it into a form amenable to a text editor and some computational analysis. You can see the inputs in `course.py` but the interesting bits are the output: `outline.md` and `slides.md`. The idea is to break the course into more, smaller segments with exercises at the ends and breaks in between. So `outline.md` lists the segments, their duration, and sums those durations up per-day. It shows we're about an hour too long right now! There are more details of the segments in `slides.md`, or you can see mostly the same stuff in `course.py`. This now contains all of the content from the v1 course, ensuring both that we've covered everything and that we'll have somewhere to redirect every page. Fixes #1082. Fixes #1465. --------- Co-authored-by: Nicole LeGare <dlegare.1001@gmail.com> Co-authored-by: Martin Geisler <mgeisler@google.com>
2023-11-29 17:39:24 +02:00
Run exerciser as mdbook renderer.
2023-04-03 17:18:32 +02:00
[output.exerciser]
Rename exercise template directory and archive.
2023-04-05 17:15:42 +02:00
output-directory = "comprehensive-rust-exercises"
Reference in New Issue Copy Permalink