Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
broncio123 opened this issue Jun 4, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@broncio123
Copy link
Member

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
@broncio123 broncio123 added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 4, 2020
@broncio123
Copy link
Member Author

Maybe make video tutorials for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant