Skip to content

Update getting started and reference docs#365

Merged
mmcky merged 3 commits into
executablebooks:masterfrom
choldgraf:docs-stream
Oct 14, 2021
Merged

Update getting started and reference docs#365
mmcky merged 3 commits into
executablebooks:masterfrom
choldgraf:docs-stream

Conversation

@choldgraf
Copy link
Copy Markdown
Member

This is a quick update on some documentation, with these main changes:

  • A bit more docs around the fancy new "merge output streams" feature, so folks are more likely to find and use it :-)
  • Moves some stuff in start/ into a dedicated configuration reference so that it's easier to find
  • Updates the start/ guide with a few more steps people can take
  • Makes a few top-level section titles "imperative" so that we cut back on wordiness (and partially inspired by https://diataxis.fr/how-to-guides/)

This is a follow up to #364

@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 5, 2021

Codecov Report

Merging #365 (a2694cc) into master (47b33d5) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #365   +/-   ##
=======================================
  Coverage   87.34%   87.34%           
=======================================
  Files          12       12           
  Lines        1367     1367           
=======================================
  Hits         1194     1194           
  Misses        173      173           
Flag Coverage Δ
pytests 87.34% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 47b33d5...a2694cc. Read the comment docs.

@mmcky mmcky requested review from chrisjsewell and mmcky October 11, 2021 02:24
mmcky
mmcky previously approved these changes Oct 11, 2021
Comment thread docs/use/formatting_outputs.md
Comment thread docs/use/formatting_outputs.md
@choldgraf
Copy link
Copy Markdown
Member Author

choldgraf commented Oct 13, 2021

thanks for the review @mmcky - I think this one is good to go unless there are objections - if I got the description wrong I am happy to iterate in subsequent PRs

(note that the codecov tests seems to be wonky because of a missing credential or something, don't think it's related to this PR)

@mmcky
Copy link
Copy Markdown
Member

mmcky commented Oct 14, 2021

thanks @choldgraf

@mmcky mmcky self-requested a review October 14, 2021 03:05
@mmcky
Copy link
Copy Markdown
Member

mmcky commented Oct 14, 2021

@choldgraf just updated from the master branch -- all looks good. I think this is good to 🚢

@mmcky
Copy link
Copy Markdown
Member

mmcky commented Oct 14, 2021

@chrisjsewell @choldgraf I will merge this later this afternoon so we can merge: jupyter-book/jupyter-book#1448

@mmcky mmcky merged commit 5d31ac4 into executablebooks:master Oct 14, 2021
mmcky added a commit to jupyter-book/jupyter-book that referenced this pull request Oct 14, 2021
mmcky added a commit to jupyter-book/jupyter-book that referenced this pull request Oct 15, 2021
* RELEASE: update to v0.12

* add myst_deprecations notification to CHANGELOG

* update CHANGELOG

* fix myst-nb intersphinx link

* FIX: broken links to myst-nb due to executablebooks/MyST-NB#365

* add thanks to contributors

* update thanks

* Sphinx 4 in github actions

* upgrade win, os x tests to python=3.8; and pypi publish workflow

* update cache key to be more generic

* use a simple test matrix to set python-version

* FIX: add $

Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants