Skip to content

Prepare Jupyter Notebook template and Guidelines for preparation of book sections #3

Open
@broncio123

Description

@broncio123

The Template NB should be able to show the following elements

  • How to insert multiple figures, figure captions and labels using a combination of Markdown and LaTex syntax
  • What LaTeX elements can be ported into the notebook without change
    • \section{} and subsection{} - requires syntax-conversion to Sphinx
    • hyperlinks: \ref{} and \label{} elements - requires syntax-conversion to Sphinx
    • equation environments
    • equation labels and references, with \eqref{}
    • citations, using \cite{} - requires syntax-conversion to Sphinx
  • How to add external links (Markdown, easy)
  • How to add a bib file for making Reference list - requires syntax-conversion to Sphinx

The Guidelines should be able to point out stuff to be done before preparing an input NB for the book and HOW-TOs. Rough outline

  • NB filenames must be self-descriptive, e.g., part1-0.ipynb or part2-2.ipynb, in lower-case and without blank spaces (DEFINE THIS)
  • use of .png instead of .pdf format for NBs
  • all labels for cross-referencing must use standard LaTex markers (sec:, subsec:, eq:, fig:, tab:) and label names must be all lower-case, without blank spaces, and (CAN'T REMEMBER) shouldn't have underscores part_1.ipynb . See template NB.
  • if inserting multiple pictures with captions and labels for a single figure, keep within a separate single cell. See template NB.
  • ... CONTINUE THINKING OF OTHERS

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions