-
Notifications
You must be signed in to change notification settings - Fork 0
/
help_old
218 lines (218 loc) · 33.1 KB
/
help_old
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
[1m--help [0m [94mPrint all command-line options for doconce[0m
[1m--<cmd-option> --help [0m [94mPrint a specific command-line option <cmd-option> for doconce[0m
[1m--debug [0m [94mWrite a debugging file _doconce_debugging.log with lots of intermediate results[0m
[1m--no_abort [0m [94mDo not abort the execution if syntax errors are found.[0m
[1m--verbose=... [0m [94mWrite progress of intermediate steps if they take longer than X seconds. 0: X=15 (default); 1: X=5; 2: X=0[0m
[1m--language=... [0m [94mNative language to be used: English (default), Norwegian, German, Basque, Arabic[0m
[1m--preprocess_include_subst [0m [94mTurns on variable substitutions in # #include paths when running Preprocess: preprocess -i -DMYDIR=rn1 will lead to the string "MYDIR" being replaced by the value "rn1" in # #include "..." statements.[0m
[1m--syntax_check=... [0m [94mValues: on/off. Turns on/off fix of illegal constructions and the syntax check (may be time consuming for large books).[0m
[1m--skip_inline_comments [0m [94mRemove all inline comments of the form [ID: comment].[0m
[1m--draft [0m [94mIndicates draft (turns on draft elements in LaTeX, otherwise no effect).[0m
[1m--CC_license=... [0m [94mTemplate wording for Creative Commons licenses. Default: "Released under CC %s 4.0 license." Example: "This work is released under the Creative Commons %s 4.0 license". CC license is specified as a part of the copyright syntax, e.g.: "AUTHOR: Kaare Dump {copyright|CC BY} at BSU & Some Company Ltd"; or: "AUTHOR: Kaare Dump at BSU & Some Company Ltd. {copyright,2005-present|CC BY-NC}". The --CC_license= option has no effect if the license does not start with CC, e.g.: "AUTHOR: Kaare Dump at BSU {copyright|Released under the MIT license.}"[0m
[1m--align2equations [0m [94mRewrite align/alignat math environments to separate equation environments. Sometimes needed for proper MathJax rendering (e.g., remark slides). Sphinx requires such rewrite and will do it regardless of this option.[0m
[1m--force_tikz_conversion [0m [94mForce generation SVG/HTML versions of tikz figures, overwriting any previously generated SVG/HTML files (applies to all formats except LaTeX)[0m
[1m--tikz_libs=... [0m [94mTikZ libraries used in figures.[0m
[1m--pgfplots_libs=... [0m [94mpgfplots libraries used in figures.[0m
[1m--IBPLOT [0m [94mautomagic translation of IBPLOT commands.[0m
[1m--exercise_numbering=... [0m [94mabsolute: exercises numbered as 1, 2, ... (default); chapter: exercises numbered as 1.1, 1.2, ... , 3.1, 3.2, ..., B.1, B.2, etc. with a chapter or appendix prefix.[0m
[1m--exercises_in_zip [0m [94mPlace each exercises as an individual DocOnce file in a zip archive.[0m
[1m--exercises_in_zip_filename=... [0m [94mFilenames of individual exercises in zip archive. logical: use the (first) logical filename specified by file=... ; number: use either absolute exercise number or chapter.localnumber.[0m
[1m--toc_depth=... [0m [94mNo of levels in the table of contents. Default: 2, which means chapters, sections, and subsections. Set to 1 to exclude subsections. Applies to all formats, except sphinx: for sphinx, set toc_depth=... as part of the command doconce sphinx_dir.[0m
[1m--encoding=... [0m [94mSpecify encoding (e.g., latin1 or utf-8).[0m
[1m--no_ampersand_quote [0m [94mTurn off special treatment of ampersand (&). Needed, e.g., when native latex code for tables are inserted in the document.[0m
[1m--no_mako [0m [94mDo not run the Mako preprocessor program.[0m
[1m--no_preprocess [0m [94mDo not run the Preprocess preprocessor program.[0m
[1m--mako_strict_undefined [0m [94mMake Mako report on undefined variables.[0m
[1m--no_header_footer [0m [94mDo not include header and footer in (LaTeX and HTML) documents.[0m
[1m--no_emoji [0m [94mRemove all emojis.[0m
[1m--siunits [0m [94mAllow siunitx MathJax/LaTeX package for support of SI units in various formats[0m
[1m--allow_refs_to_external_docs [0m [94mDo not abort translation if ref{...} to labels not defined in this document.[0m
[1m--userdef_environment_file=... [0m [94mRead user-defined environments from this file instead of the default (userdef_environments.py)[0m
[1m--runestone [0m [94mMake a RunestoneInteractive version of a Sphinx document.[0m
[1m--max_bc_linelength=... [0m [94mStrip lines in !bc environments that are longer than specified (to prevent too long lines). Default: None (no length restriction).[0m
[1m--replace_ref_by_latex_auxno=... [0m [94mReplace all ref{...} by hardcoded numbers from a latex .aux file. Makes it possible for a notebook or html page to refer to a latex textbook. Recommended syntax: see (ref{my:eq1}) in cite{MyBook}, or see Section ref{my:sec2} in cite{MyBook}.[0m
[1m--keep_pygments_html_bg [0m [94mDo not allow change of background in code blocks in HTML.[0m
[1m--minted_latex_style=... [0m [94mSpecify the minted style to be used for typesetting code in LaTeX. See pygmetize -L styles for legal names.[0m
[1m--pygments_html_style=... [0m [94mSpecify the minted/pygments style to be used for typesetting code in HTML. Default: default (other values: monokai, manni, rrt, perldoc, borland, colorful, murphy, trac, tango, fruity, autumn, emacs, vim, pastie, friendly, native, see pygmentize -L styles). none, no, off: turn off pygments to typeset computer code in HTML, use plain <pre> tags. highlight.js: use highlight.js syntax highlighting, not pygments.[0m
[1m--pygments_html_linenos [0m [94mTurn on line numbers in pygmentized computer code in HTML. (In LaTeX line numbers can be added via doconce subst or doconce replace such that the verbatim environments get the linenos=true parameter.)[0m
[1m--xhtml [0m [94mUse BeautifulSoap to try to produce XHTML output. It inserts end tags (e.g. </p>) and guesses where to do it.[0m
[1m--html_output=... [0m [94mAlternative basename of files associated with the HTML format.[0m
[1m--html_style=... [0m [94mName of theme for HTML style: plain, blueish, blueish2, bloodish, tactile-black, tactile-red, rossant solarized, solarized2_light, solarized2_dark, bootstrap, bootswatch, bootstrap_X (with X=bloodish, blue, bluegray, brown, cbc, FlatUI, red), bootswatch_X (with X=cerulean, cosmo, flatly, journal, lumen, readable, simplex, spacelab, united, yeti (dark:) amelia, cyborg, darkly, slate, spruce, superhero (demos at bootswatch.com))[0m
[1m--html_template=... [0m [94mSpecify an HTML template with header/footer in which the doconce document is embedded. (Often preferred to run with --no_title)[0m
[1m--no_title [0m [94mComment out TITLE, AUTHOR, DATE. Often used with HTML templates.[0m
[1m--html_code_style=... [0m [94moff, inherit, or transparent: enable normal inline verbatim font where foreground and background color is inherited from the surroundnings. off, inherit and transparent are just synonyms for inheriting color from the text and make the background color transparent (use e.g. --html_code_style=inherit to avoid the red Boostrap color). Default: on (use the css-specified typesetting of <pre> tags). NOTE: the naming "html_code_style" is not optimal: it has nothing to do with code block style, but the <code> tag for inline verbatim text in the context of bootstrap css styles.[0m
[1m--html_pre_style=... [0m [94moff, inherit, or transparent: let code blocks inside <pre> tags have foreground and background color inherited from the surroundnings. Default: on (use the css-specified typesetting of <pre> tags). This option is most relevant for Bootstrap styles to avoid white background in code blocks inside colorful admons.[0m
[1m--html_toc_indent=... [0m [94mNo of spaces for indentation of subsections in the table of contents in HTML output. Default: 3 (0 gives toc as nested list in Bootstrap-based styles).[0m
[1m--html_body_style=... [0m [94mOverride elements in the <body> style css. Used to enlargen bootswatch fonts, for instance: "--html_body_style=font-size:20px;line-height:1.5"[0m
[1m--html_body_font=... [0m [94mSpecify HTML font for text body. =? lists available fonts.[0m
[1m--html_heading_font=... [0m [94mSpecify HTML font for headings. =? lists available fonts.[0m
[1m--html_video_autoplay=... [0m [94mTrue for autoplay when HTML is loaded, otherwise False (default).[0m
[1m--html_admon=... [0m [94mType of admonition and color: colors, gray, yellow, apricot, lyx, paragraph. For html_style=bootstrap*,bootswatch*, the two legal values are boostrap_panel, bootstrap_alert.[0m
[1m--html_admon_shadow [0m [94mAdd a shadow effect to HTML admon boxes (gray, yellow, apricot).[0m
[1m--html_admon_bg_color=... [0m [94mBackground color of admon in HTML.[0m
[1m--html_admon_bd_color=... [0m [94mBoundary color of admon in HTML.[0m
[1m--css=... [0m [94mSpecify a .css style file for HTML output. If the file does not exist, the default or specified style (--html_style=) is written to it.[0m
[1m--html_box_shadow [0m [94mAdd a shadow effect in HTML box environments.[0m
[1m--html_share=... [0m [94mSpecify URL and there will be Facebook, Twitter, etc. buttons at the end of the HTML document. --html_share=https://mysite.com/specials shares on email, Facebook, Google+, LinkedIn, Twitter, and enables a print button too. --html_share=https://mysite.com/specials,twitter,facebook shares on Twitter and Facebook only. Sites are separated by comma. The following names are allowed: email, facebook, google+, linkedin, twitter, print.[0m
[1m--html_exercise_icon=... [0m [94mSpecify a question icon (as a filename in the bundled/html_images directory in the doconce repo) for being inserted to the right in exercises. default: turn on predefined question icons according to the chosen style. none: no icons (this is the default value).[0m
[1m--html_exercise_icon_width=... [0m [94mWidth of the icon image in pixels (must be used with --html_exercise_icon).[0m
[1m--html_raw_github_url=... [0m [94mURLs to files hosted on the doconce github account. Internet Explorer (and perhaps other browsers) will not show raw.github.com files. Instead on should use rawgit.com. For development of HTML sites in Safari and Chrome and can use rawgit.com.
Values of --html_raw_github_url=: safe or cdn.rawgit: use this for ready-made sites with potentially some traffic. The URL becomes https://cdn.rawgit.com/doconce/doconce/...
test or rawgit: use this for test purposes and development with low traffic. The URL becomes https://rawgit.com/doconce/doconce/...
github or raw.github: the URL becomes https://raw.github.com and may fail to load properly.
githubusercontent or raw.githubusercontent: The URL becomes https://raw.githubusercontent.com and may fail to load properly.[0m
[1m--html_DOCTYPE [0m [94mInsert <!DOCTYPE HTML> in the top of the HTML file. This is required for Internet Explorer and Mozilla. However, some of the CSS files used by DocOnce may not load properly if they are not well formed. That is why no doctype is default in the generated HTML files.[0m
[1m--html_links_in_new_window [0m [94mOpen HTML links in a new window/tab.[0m
[1m--html_quiz_button_text=... [0m [94mText on buttons for collapsing/expanding answers and explanations in quizzes (with bootstrap styles). Default: Empty (just pencil glyphion).[0m
[1m--html_bootstrap_navbar=... [0m [94mTurns the Bootstrap navigation bar on/off. Default: on.[0m
[1m--html_bootstrap_jumbotron=... [0m [94mTurns the Bootstrap jumbotron intro on/off and governs the size of the document title. Default: on. Other values: h2, off (h2 gives h2 heading instead of h1, off gives no jumbotron).[0m
[1m--html_bootstrap_navbar_links=... [0m [94mAllows custom links in the navigation bar. Format: link|url;link|url;link|url . Example: "--html_bootstrap_navbar_links=Google|https://google.com;hpl|https://folk.uio.no/hpl"[0m
[1m--html_figure_caption=... [0m [94mPlacement of figure caption: top (default) or bottom. (sidecap=True is another option, this can be set for individual figures, while --html_figure_caption controls the general caption placement of all figures.[0m
[1m--html_figure_hrule=... [0m [94mSet horizontal rule(s) above and/or below a figure. top: rule at top (default); none, off: no rules; bottom: rule at bottom; top+bottom: rule at top and bottom[0m
[1m--html_copyright=... [0m [94mControls where to put copyright statements. everypage: in the footer of every page; titlepages or titlepage: in the footer of the titlepage only (default).[0m
[1m--cite_doconce [0m [94mAdds a citation to the DocOnce web page if copyright statements are present.[0m
[1m--device=... [0m [94mSet device to paper, screen, or other (paper impacts LaTeX output).[0m
[1m--number_all_equations [0m [94mSwitch latex environments such that all equations get a number.[0m
[1m--denumber_all_equations [0m [94mSwitch latex environments such no equations get a number (useful for removing equation labels in slides). Error messages are issued about references to numbered equations in the text.[0m
[1m--latex_style=... [0m [94mLaTeX style package used for the document.
std: standard LaTeX article or book style,
Springer_sv: Springer's svmono class (the new standard for all Springer books),
Springer_T2: Springer's T2 book style,
Springer_T4: Springer's T4 book style (smaller pagesize than T2),
Springer_lncse: Springer's Lecture Notes in Computational Science and Engineering (LNCSE) style,
Springer_llncs: Springer's Lecture Notes in Computer Science style,
Springer_lnup: Springer's Lecture Notes in University Physics,
Springer_collection: Springer's style for chapters in LNCSE proceedings,
tufte-book: use of tufte-book.cls for E. Tufte-inspired layout,
Koma_Script: Koma Script style,
siamltex: SIAM's standard LaTeX style for papers,
siamltexmm: SIAM's extended (blue) multimedia style for papers.
elsevier: Elsevier Style[0m
[1m--latex_font=... [0m [94mLaTeX font choice: helvetica, palatino, utopia, std (Computer Modern, default).[0m
[1m--latex_code_style=... [0m [94m
Typesetting of code blocks.
pyg: use pygments (minted), style is set with --minted_latex_style=
lst: use lstlistings
vrb: use Verbatim (default)
Specifications across languages:
pyg-blue1
lst, lst-yellowgray[style=redblue]
vrb[frame=lines,framesep=2.5mm,framerule=0.7pt]
Detailed specification for each language:
default:vrb-red1[frame=lines]@pycod:lst[style=redblue]@pypro:lst-blue1[style=default]@sys:vrb[frame=lines,label=\fbox{{\tiny Terminal}},framesep=2.5mm,framerule=0.7pt]
Here, Verbatim[frame=lines] is used for all code environments, except pycod, pypro and sys, which have their own specifications.
pycod: lst package with redblue style (and white background)
pypro: lst package with default style and blue1 background
style, sys: Verbatim with the specified arguments and white background.
(Note: @ is delimiter for the language specifications, syntax is envir:package-background[style parameters]@)[0m
[1m--latex_code_leftmargin=... [0m [94mSets the left margin in code blocks. Default: 7 (mm).[0m
[1m--latex_code_bg=... [0m [94mBackground color code blocks. Default: white.[0m
[1m--latex_code_bg_vpad [0m [94mVertical padding of background. Has only effect for vrb/pyg-bgcolor styles (not lst!).[0m
[1m--latex_code_lststyles=... [0m [94mFilename with LaTeX definitions of lst styles.[0m
[1m--latex_copyright=... [0m [94mControls where to put copyright statements. everypage: in the footer of every page; titlepages: in the footer of the titlepage and chapter pages (for books) only (default).[0m
[1m--latex_bibstyle=... [0m [94mLaTeX bibliography style. Default: plain.[0m
[1m--section_numbering=... [0m [94mTurn section numbering on/off. Default: off for all formats except latex and pdflatex (on for those).[0m
[1m--latex_table_format=... [0m [94mDefault: quote. Other values: left, center, footnotesize, tiny.[0m
[1m--latex_table_row_sep=... [0m [94mRow separation factor in tables (command \renewcommand{\arraystretch}{<factor>}. Default: 1.0[0m
[1m--latex_title_layout=... [0m [94mLayout of the title, authors, and date: std: traditional LaTeX layout; titlepage: separate page; doconce_heading (default): authors with "footnotes" for institutions; beamer: layout for beamer slides.[0m
[1m--latex_link_color=... [0m [94mColor used in hyperlinks. Default is dark blue if --device=screen, or black if --device=paper (invisible in printout or special blue color if --latex_section_headings=blue or strongblue). Values are specified either as comma-separated rgb tuples or as color names, e.g., --latex_link_color=0.1,0.9,0.85 or --latex_link_color=red or --latex_link_color=gray!70[0m
[1m--latex_title_reference=... [0m [94mlatex code placed in a footnote for the title, typically used for acknowledging publisher/source of original version of the document.[0m
[1m--latex_encoding=... [0m [94mEncoding for \usepackage[encoding]{inputenc}. Values: utf8 (default) or latin1.[0m
[1m--latex_packages=... [0m [94mComma-separated list of latex packages to be included in \usepackage commands..[0m
[1m--latex_papersize=... [0m [94mGeometry of page size: a6, a4, std (default).[0m
[1m--latex_list_of_exercises=... [0m [94mLaTeX typesetting of list of exercises: loe: special, separate list of exercises; toc: exercises included as part of the table of contents; none (default): no list of exercises.[0m
[1m--latex_movie=... [0m [94mSpecify package for handling movie/video content. Default: href (hyperlink to movie file). Other options: media9, movie15, multimedia (Beamer's \movie command).[0m
[1m--latex_movie_controls=... [0m [94mSpecify control panel for movies. Default: on. Other options: off.[0m
[1m--latex_external_movie_viewer [0m [94mAllow external movie viewer for movie15 package.[0m
[1m--latex_fancy_header [0m [94mTypesetting of headers on each page: If article: section name to the left and page number to the right on even page numbers, the other way around on odd page numners. If book: section name to the left and page numner to the right on even page numbers, chapter name to the right and page number to the left on odd page numbers.[0m
[1m--latex_section_headings=... [0m [94mTypesetting of title/section/subsection headings: std (default): standard LaTeX; blue: gray blue color; strongblue: stronger blue color; gray: white text on gray background, fit to heading width; gray-wide: white text on gray background, wide as the textwidth.[0m
[1m--latex_colored_table_rows=... [0m [94mColors on every two line in tables: no (default), gray, blue.[0m
[1m--latex_line_numbers [0m [94mInclude line numbers for the running text (only active if there are inline comments.[0m
[1m--latex_todonotes [0m [94mUse the todonotes package to typeset inline comments. Gives colored bubbles in the margin for small inline comments and in the text for larger comments.[0m
[1m--latex_double_spacing [0m [94mSets the LaTeX linespacing to 1.5 (only active if there are inline comments).[0m
[1m--latex_labels_in_margin [0m [94mPrint equation, section and other LaTeX labels in the margin.[0m
[1m--latex_index_in_margin [0m [94mPlace entries in the index also in the margin.[0m
[1m--latex_preamble=... [0m [94mUser-provided LaTeX preamble file, either complete or additions to the doconce-generated preamble.[0m
[1m--latex_no_program_footnotelink [0m [94mIf --device=paper, this option removes footnotes with links to computer programs.[0m
[1m--latex_admon=... [0m [94mType of admonition in LaTeX:
colors1: (inspired by the NumPy User Guide) applies different colors for the different admons with an embedded icon;
colors2: like `colors1` but the text is wrapped around the icon;
mdfbox: rounded boxes with a optional title and no icon (default);
graybox2: box with square corners, gray background, and narrower than mdfbox, if code it reduces to something like mdfbox (mdframed based); the summary admon is in case of A4 format only half of the text width with text wrapped around (effective for proposals and articles);
grayicon: box with gray icons and a default light gray background;
yellowicon: box yellow icons and a default light yellow background;
paragraph: plain paragraph with boldface heading.
Note: the colors in mdfbox and other boxes can customized.[0m
[1m--latex_admon_color=... [0m [94mThe color to be used as background in admonitions. A single value applies to all admons: either rgb tuple (--latex_admon_color=0.1,0.1,0.4) or saturated color ('--latex_admon_color=yellow!5' - note the quotes needed for bash).
Multiple values can be assigned, one for each admon (all admons must be specified): '--latex_admon_color=warning:darkgreen!40!white;notice:darkgray!20!white;summary:tucorange!20!white;question:red!50!white;block:darkgreen!40!white' If --latex_admon=mdfbox, the specification above with color1!X!color2 will automatically trigger 2*X as the background color of the frametitle.
There are predefined multiple values, e.g., --latex_admon_color=colors1 gives red warnings, blue notice, orange questions, green summaries and yellow blocks, automatically adjusted with darker frametitles.
If --latex_admon=mdfbox, the background of the title and the color of the border of box can also be customized by direct editing. For example, a dark blue border and light blue title background is obtained by editing the .tex file as
doconce replace 'linecolor=black,' 'linecolor=darkblue,' mydoc.tex
doconce subst 'frametitlebackgroundcolor=.*?,' 'frametitlebackgroundcolor=blue!5,' mydoc.tex
Actually, this particular (and common) edit is automatically done by the option --latex_admon_color=bluestyle
--latex_admon_color=yellowstyle (the latter has color yellow!5 instead and yellow!20 for the border)[0m
[1m--latex_admon_title_no_period [0m [94mBy default, a period is added to title admons that do not have a period, question mark, or similar. This option prevents adding a period such that the title acts like a heading.[0m
[1m--latex_admon_envir_map=... [0m [94mMapping of code envirs to new envir names inside admons, e.g., to get a different code typesetting inside admons. This is useful if admons have a special color and the color background of code blocks does not fit will with the color background inside admons. Then it is natural to use a different verbatim code style inside admons. If specifying a number, say 2, as in --latex_admon_envir_map=2, an envir like pycod gets the number appended: pycod2. One can then in --latex_code_style= or in doconce ptex2tex or ptex2tex specify the typesetting of pycod2 environments. Otherwise the specification must be a mapping for each envir that should be changed inside the admons: --latex_admon_envir_map=pycod-pycod_yellow,fpro-fpro2 (from-to,from-to,... syntax).[0m
[1m--latex_subex_header_postfix=... [0m [94mDefault: ). Gives headers a), b), etc. Can be set to period, colon, etc.[0m
[1m--xelatex [0m [94mUse xelatex instead of latex/pdflatex.[0m
[1m--latex_double_hyphen [0m [94mReplace single dash - by double dash -- in LaTeX output. Somewhat intelligent, but may give unwanted edits. Use with great care![0m
[1m--latex_elsevier_journal=... [0m [94mSets the journal name for the --latex_style=elsevier style. Default: none (no journal name).[0m
[1m--ipynb_split_pyshell=... [0m [94mSplit interactive sessions into multiple cells after each output. Applies to pyshell and ipy code environments. on, True, yes: split (default). off, False, no: do not split. Note that pyshell-t and ipy-t environments just displays the session, while default pyshell and ipy removes all output (all output from print statements will come after the entire session).[0m
[1m--ipynb_disable_mpl_inline [0m [94mDisable automatic insertion of `%matplotlib inline` before the first import of matplotlib.[0m
[1m--ipynb_cite=... [0m [94mTypesetting of bibliography. plain: simple native typesetting (same as pandoc) (default); latex-plain: Similar to latex-style plain; latex: ipynb support for latex-style bibliographies (not mature).[0m
[1m--ipynb_admon=... [0m [94mTypesetting of admonitions (hint, remarks, box, notice, summary, warning, question, block - quotes are typeset as quotes). quote: as Markdown quote (default) with gray line on the left. paragraph: just the content with the title as paragraph heading. hrule: title with horizontal rule above and below, then text and horozontal rule.[0m
[1m--ipynb_figure=... [0m [94mHow to typeset figures in ipynb: md (plain Markdown syntax); imgtag (<img src="..." width=...> tag, default); Image (python cell with Image object).[0m
[1m--ipynb_movie=... [0m [94mHow to typeset movies in ipynb: md (plain Markdown syntax, default); HTML: python cell with notebook `HTML` object containing the raw HTML code that is used in the DocOnce HTML format; ipynb: python cell with notebook `HTML` object with simple/standard ipynb HTML code for showing a YouTube or local video with a <video> tag.[0m
[1m--ipynb_non_editable_text [0m [94mAll text in a notebook is set to be uneditable. Code blocks are unchanged[0m
[1m--ipynb_non_editable_code [0m [94mAll codeblocks in a notebook is set to be uneditable[0m
[1m--verbose [0m [94mWrite out all OS commands run by doconce.[0m
[1m--examples_as_exercises [0m [94mTreat examples of the form "==== Example: ..." as in exercise environments.[0m
[1m--exercises_as_subsections [0m [94mForces exercises to be typeset as subsections. Used to override various latex environments for exercises (esp. in Springer styles).[0m
[1m--solutions_at_end [0m [94mShow solutions to exercises at the end of the document.[0m
[1m--without_solutions [0m [94mLeave out solution environments from exercises.[0m
[1m--answers_at_end [0m [94mShow answers to exercises at the end of the document.[0m
[1m--without_answers [0m [94mLeave out answer environments from exercises.[0m
[1m--without_hints [0m [94mLeave out hints from exercises.[0m
[1m--exercise_solution=... [0m [94mTypesetting of solutions: paragraph, admon, or quote.[0m
[1m--wordpress [0m [94mMake HTML output for wordpress.com pages.[0m
[1m--tables2csv [0m [94mWrite each table to a CSV file table_X.csv, where X is the table number (autonumbered in according to appearance in the DocOnce source file).[0m
[1m--sections_up [0m [94mUpgrade all sections: sections to chapters, subsections to sections, etc.[0m
[1m--sections_down [0m [94mDowngrade all sections: chapters to sections, sections to subsections, etc.[0m
[1m--os_prompt=... [0m [94mTerminal prompt in output from running OS commands (the @@@OSCMD instruction). None or empty: no prompt, just the command; nocmd: no command, just the output. Default is "Terminal>".[0m
[1m--code_skip_until=... [0m [94m@@@CODE import: skip lines in files up to (and incuding) specified line.[0m
[1m--code_prefix=... [0m [94mPrefix all @@@CODE imports with some path.[0m
[1m--figure_prefix=... [0m [94mPrefix all figure filenames with, e.g., an URL.[0m
[1m--movie_prefix=... [0m [94mPrefix all movie filenames with, e.g., an URL.[0m
[1m--no_mp4_webm_ogg_alternatives [0m [94mUse just the specified (.mp4, .webm, .ogg) movie file; do not allow alternatives in HTML5 video tag. Used if the just the specified movie format should be played.[0m
[1m--handout [0m [94mMakes slides output suited for printing.[0m
[1m--urlcheck [0m [94mCheck that all URLs referred to in the document are valid.[0m
[1m--labelcheck=... [0m [94mCheck that all ref{X} has a corresponding label{X}. Fake examples will fail this check and so will generalized references. Turn on when useful. Values: off (default), on.[0m
[1m--short_title=... [0m [94mShort version of the document's title.[0m
[1m--markdown [0m [94mAllow Markdown (and some Extended Markdown) syntax as input.[0m
[1m--md2do_output=... [0m [94mDump to file the DocOnce code arising from converting from Markdown. Default value is None (no dump). Any filename can be specified: --md2do_output=myfile.do.txt[0m
[1m--github_md [0m [94mTurn on GitHub-flavored Markdown dialect of the pandoc translator[0m
[1m--slate_md [0m [94mTurn on Slate-extensions to Markdown in the pandoc translator. To be used together with --github_md.[0m
[1m--strapdown [0m [94mWrap Markdown output in HTML header/footer such that the output file (renamed as .html) can automatically be rendered as an HTML via strapdownjs.com technology. Combine with --github_md for richer output. Styles are set with --bootswatch_theme=cyborg (for instance).[0m
[1m--bootswatch_theme=... [0m [94mBootswatch theme for use with --strapdown option.[0m
[1m--strict_markdown_output [0m [94mEnsure strict/basic Markdown as output.[0m
[1m--multimarkdown_output [0m [94mAllow MultiMarkdown as output.[0m
[1m--quiz_question_prefix=... [0m [94mPrefix/title before question in quizzes. Default: "Question:". Can also be set in square brackets for each individual question. ("Q: [] What is 1+1?" results in no prefix/title before the "What is 1+1?".[0m
[1m--quiz_choice_prefix=... [0m [94mPrefix/title before choices in quizzes.
Default for HTML: "Choice", resulting in numbered choices "Choice 1:", "Choice 2:", etc.
A value with colon, period, or question mark (e.g., "Answer:") leaves out the numbering.
Default for latex/pdflatex: letter or letter+checkbox.
Other values: number, number+checkbox, number+circle, letter+circle, letter.
The checkbox or circle is always omitted if answers or solutions are included (i.e., if none of the --without_answers and --without_solutions is set).
The choice prefix can also be set in square brackets for each individual choice. ("Cr: [] Two" results in no prefix/title before the the answer "Two".[0m
[1m--quiz_horizontal_rule=... [0m [94mon (default): <hr> before and after quiz in HTML. off: no <hr>.[0m
[1m--quiz_explanations=... [0m [94mon/off. Some output formats do not support explanations with figures, math and/or code, this option turns all explanations off.[0m
[1m--rst_uio [0m [94mUniv. of Oslo version of rst files for their Vortex system.[0m
[1m--rst_mathjax [0m [94mUse raw HTML with MathJax for LaTeX mathematics in rst files.[0m
[1m--sphinx_preserve_bib_keys [0m [94mUse the user's keys to in bibliography instead of numbers[0m
[1m--sphinx_keep_splits [0m [94mRespect user's !split commands. Default: Override user's !split and insert new !split before all topmost sections. This is what makes sense in a Sphinx Table of Contents if one wants to split the document into multiple parts.[0m
[1m--sphinx_figure_captions=... [0m [94mFont style in figure captions: emphasize (default) or normal. If you use boldface or emphasize in the caption, the font style will be normal for that caption.[0m
[1m--oneline_paragraphs [0m [94mCombine paragraphs to one line (does not work well).[0m
[1m--execute [0m [94mAutomatically run code blocks and show output below the code block.[0m
[1m--verbose-execute [0m [94mPrint output from execute cells.[0m
[1m--ignore_output [0m [94mIgnore output cells. Useful when you want to use execute rather than predefined output cells.[0m
[1m--html_responsive_figure_width [0m [94mUse figure width as max-width, and set width to 100 percent so that figures can shrink to device width.[0m