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

Update contribution.rst #181

Merged
merged 1 commit into from
Aug 14, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 53 additions & 1 deletion docs/source/contribution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,59 @@ We use `sphinx <https://www.sphinx-doc.org/en/master/>`__ to manage the document

The source files for docs are .rst file in docs/source.

For English docs, ``sphinx-build source build/html`` in docs dir is enough. The html version of the docs are in docs/build/html.
For English docs, ``sphinx-build source build/html`` and ``make latexpdf LATEXMKOPTS="-silent"`` in docs dir are enough.
The html and pdf version of the docs are in docs/build/html and docs/build/latex, respectively.

**Formula Environment Attention**

It should be noted that the formula environment ``$$CONTENT$$`` in markdown is equivalent to the ``equation`` environment in latex.
Therefore, in the jupyter notebook documents, do not nest the formula environment in ``$$CONTENT$$`` that is incompatible with
``equation`` in latex, such as ``eqnarray``, which will cause errors in the pdf file built by ``nbsphinx``.
However, compatible formula environments can be used. For example, this legal code in markdown

.. code-block:: markdown

$$
\begin{split}
X&=Y\\
&=Z
\end{split}
$$

will be convert to

.. code-block:: latex

\begin{equation}
\begin{split}
X&=Y\\
&=Z
\end{split}
\end{equation}

in latex automatically by ``nbsphinx``, which is a legal latex code. However, this legal code in markdown

.. code-block:: markdown

$$
\begin{eqnarray}
X&=&Y\\
&=&Z
\end{eqnarray}
$$

will be convert to

.. code-block:: latex

\begin{equation}
\begin{eqnarray}
X&=&Y\\
&=&Z
\end{eqnarray}
\end{equation}

in latex, which is an illegal latex code.

**Auto Generation of API Docs:**

Expand Down