https://github.com/xxks-kkk/sphinxcontrib-pseudocode

A sphinx-doc extension that allows you to write LaTeX algorithm directly inside sphinx-doc
https://github.com/xxks-kkk/sphinxcontrib-pseudocode

latex latex-algorithm latex-algorithm-on-html

Last synced: about 1 month ago
JSON representation

A sphinx-doc extension that allows you to write LaTeX algorithm directly inside sphinx-doc

• Host: GitHub
• URL: https://github.com/xxks-kkk/sphinxcontrib-pseudocode
• Owner: xxks-kkk
• License: other
• Created: 2021-11-20T02:51:28.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-05-01T17:23:48.000Z (over 2 years ago)
• Last Synced: 2024-10-05T02:08:30.964Z (3 months ago)
• Topics: latex, latex-algorithm, latex-algorithm-on-html
• Language: Python
• Homepage:
• Size: 354 KB
• Stars: 9
• Watchers: 2
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.rst

Awesome Lists containing this project

README

        
# sphinxcontrib-pseudocode

This is a [sphinx-doc](https://www.sphinx-doc.org/en/master/) extension that allows you to write LaTeX algorithm

directly inside sphinx-doc. The rendering of LaTex algorithm is powered by 

[pseudocode.js](https://github.com/SaswatPadhi/pseudocode.js).

## Demo

You can directly type LaTeX algorithm (e.g., quicksort algorithm taken from pseudocode.js demo) under ``pcode``

directive in any `.rst` files as follows:

```text

.. pcode::

   :linenos:

    % This quicksort algorithm is extracted from Chapter 7, Introduction to Algorithms (3rd edition)

    \begin{algorithm}

    \caption{Quicksort}

    \begin{algorithmic}

    \PROCEDURE{Quicksort}{$A, p, r$}

        \IF{$p < r$}

            \STATE $q = $ \CALL{Partition}{$A, p, r$}

            \STATE \CALL{Quicksort}{$A, p, q - 1$}

            \STATE \CALL{Quicksort}{$A, q + 1, r$}

        \ENDIF

    \ENDPROCEDURE

    \PROCEDURE{Partition}{$A, p, r$}

        \STATE $x = A[r]$

        \STATE $i = p - 1$

        \FOR{$j = p$ \TO $r - 1$}

            \IF{$A[j] < x$}

                \STATE $i = i + 1$

                \STATE exchange

                $A[i]$ with     $A[j]$

            \ENDIF

            \STATE exchange $A[i]$ with $A[r]$

        \ENDFOR

    \ENDPROCEDURE

    \end{algorithmic}

    \end{algorithm}

```

The above code will be rendered as 

![quicksort-demo](https://raw.githubusercontent.com/xxks-kkk/sphinxcontrib-pseudocode/master/tests/roots/test-basic/_static/quicksort-demo.png)

See more examples on [demo page](https://zhu45.org/sphinxcontrib-pseudocode/).

## Installation and Configuration

Install the package via 

```

pip install sphinxcontrib-pseudocode

```

Then in the Sphinx-doc ``conf.py``, add

```

extensions = [

    'sphinxcontrib.pseudocode'

]

```

## Usage

Write LaTeX algorithm within ``pcode`` directive as shown above. The following option is supported:

- ``linenos`` (``LineNumber`` in pseudocode.js: Whether line numbering is enabled)

## For Developer

This [blog](https://zhu45.org/posts/2021/Dec/21/release-of-sphinxcontrib-pseudocode/) explains the underlying implementation details of this extension.