1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
|
=============================================
nbconvert: Convert Notebooks to other formats
=============================================
Using ``nbconvert`` enables:
- **presentation** of information in familiar formats, such as PDF.
- **publishing** of research using LaTeX and opens the door for embedding
notebooks in papers.
- **collaboration** with others who may not use the notebook in their
work.
- **sharing** contents with many people via the web using HTML.
Overall, notebook conversion and the ``nbconvert`` tool give scientists and
researchers the flexibility to deliver information in a timely way across
different formats.
Primarily, the ``nbconvert`` tool allows you to convert a Jupyter ``.ipynb``
notebook document file into another static format including HTML, LaTeX, PDF,
Markdown, reStructuredText, and more. ``nbconvert`` can also add productivity
to your workflow when used to execute notebooks programmatically.
If used as a Python library (``import nbconvert``), ``nbconvert`` adds
notebook conversion within a project. For example, ``nbconvert`` is used to
implement the "Download as" feature within the Jupyter Notebook web
application. When used as a command line tool (invoked as
``jupyter nbconvert ...``), users can conveniently convert just one or a
batch of notebook files to another format.
**Contents:**
.. toctree::
:maxdepth: 2
:caption: User Documentation
install
usage
nbconvert_library
latex_citations
execute_api
.. toctree::
:maxdepth: 2
:caption: Configuration
config_options
customizing
external_exporters
.. toctree::
:maxdepth: 2
:caption: Developer Documentation
architecture
api/index
development_release
.. toctree::
:maxdepth: 2
:caption: About nbconvert
changelog
.. toctree::
:maxdepth: 1
:caption: Questions? Suggestions?
Jupyter mailing list <https://groups.google.com/forum/#!forum/jupyter>
Jupyter website <https://jupyter.org>
Stack Overflow - Jupyter <https://stackoverflow.com/questions/tagged/jupyter>
Stack Overflow - Jupyter-notebook <https://stackoverflow.com/questions/tagged/jupyter-notebook>
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|