Skip to content

Commit

Permalink
Fixed html doc usage docs to fix 6.x (#1386)
Browse files Browse the repository at this point in the history
* Fixed html doc usage docs to fix 6.x

* Apply suggestions from code review

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>

* Doc fix for build

* Actual fix for docs

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
  • Loading branch information
MSeal and willingc authored Sep 13, 2020
1 parent 5d80847 commit 162c6d3
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
14 changes: 9 additions & 5 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ Changes in nbconvert
6.0.2
-----

A patch for a few minor issues raised out of the 6.0 release.

Comprehensive notes
~~~~~~~~~~~~~~~~~~~

Fixing Problems
+++++++++++++++
- Added windows work-around fix in CLI for async applications :ghpull:`1383`:
Expand All @@ -23,8 +28,8 @@ Testing, Docs, and Builds

A quick patch to fix an issue with get_exporter :ghpull:`1367`:

6.0.0
-----
6.0
---

The following authors and reviewers contributed the changes for this release -- Thanks you all!

Expand Down Expand Up @@ -69,9 +74,8 @@ The following authors and reviewers contributed the changes for this release --
* Tyler Makaro
* Yu-Cheng (Henry) Huang


Significant changes
~~~~~~~~~~~~~~~~~~~~
Significant Changes
~~~~~~~~~~~~~~~~~~~

Nbconvert 6.0 is a major release of nbconvert which includes many significant changes.

Expand Down
13 changes: 8 additions & 5 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,18 @@ HTML
~~~~
* ``--to html``

- ``--template full`` (default)
HTML Export. Note on backward compatibility: Be aware that if you were using custom copies of the old 5.x
template files (i.e. ``--template``), you will now need to use ``--template-file path/to/old/file.tpl``
in order to use that file in compatibility mode as opposed to other options.

- ``--template lab`` (default)

A full static HTML render of the notebook.
This looks very similar to the interactive view.
This looks very similar to the jupyter lab interactive view.

- ``--template basic``
- ``--template classic``

Simplified HTML, useful for embedding in webpages, blogs, etc.
This excludes HTML headers.
Simplified HTML, using the classic jupyter look and feel.

.. _convert_latex:

Expand Down

0 comments on commit 162c6d3

Please sign in to comment.