Sophon: Automatic API Markdown Documentation Generation for Python
What is Sophon?
Before I tell you what is Sophon, let me ask you a question: Are you ever tired of writing docstrings that look like this?
def dump(obj, filename, encrypt=False): """Dump a object into file. :param obj: A Python object :type obj: any :param filename: Filename of the file to dump :type filename: str :param encrypt: Whether or not to encrypt the file :type encrypt: bool :returns: Whether or not to dump successfully :rtype: bool """ pass
reStructuredText is great, but docstring written in reST creates visually dense, and hard to read. Compare the jumble above to the same thing rewritten according to the Sophon Style Python Docstring:
def dump(obj, filename, encrypy=False): """Dump a object into file. # Arguments obj: `any`. A Python object. filename: `str`. Filename of the file to dump. encrypt: `bool`. Whether or not to encrypt the file. # Return `bool`: Whether or not to dump successfully. """
Use Sophon to parse the docstring and we get Markdown:
<span style="float:right;">[[source]](repo/blob/branch/__main__.py#L19)</span> ## dump ```python dump(obj, filename, encrypy=False) ``` Dump a object into file. **Arguments** - **obj**: `any`. A Python object. - **filename**: `str`. Filename of the file to dump. - **encrypt**: `bool`. Whether or not to encrypt the file. **Return** - **`bool`**: Whether or not to dump successfully. ---
which is rendered by MkDocs with theme
Much more legible, no?
As you see, Sophon is a tool that could automatically generate Markdown-format API documentations from Python docstring, just like Epydoc (supports reStructuredText, Javadoc, plaintext) and Napoleon (Sphinx extension that enables Sphinx to parse both NumPy and Google style docstrings to reStructuredText).
Sophon is written by Zhenpeng Deng(monitor1379) and licensed under the MIT license.
Support different kinds of docstrings. Sophon mainly supports to parse docstring with the following styles and converts them to Markdown:
- Sophon style docstring
- (Coming Soon) Google style, the style recommended by Khan Academy
- (Coming Soon) NumPy style
Sophon also supports to parse every docstring in Python project, including docstrings on:
variableswill be supported soon)
Output Markdown format documentations. Markdown is a way to write contents for the web. Unlike cumbersome word processing applications or other markup languages with complicated syntax, text written in Markdown can be easy to read, easy to write and easily shared for between computers, mobile phones, and people. Though it does not do anything fancy like change the font size, color or type by itself, it has enough stuffs to write an API documentation for your python projects.
Another important reason of choosing Markdown is that there are some remarkable tools for Markdown to build beautiful documentations or blogs such as MkDocs(Project documentation with Markdown) or Hexo(A fast, simple & powerful blog framework).
Easily and Highly customizable. Sophon uses YAML: YAML Ain't Markup Language as the format of configuration file. By configuring and providing Markdown template files, you can freely organize your documentation, or open some advanced features such as linking API to source files deposited on GitHub repositories.
One-Command build. you only need one command to build you API documentation.
What does "Sophon" mean?
Sophon is the official translation of "智子" in 《Rememberance of Earth's Past II: The Dark Forest》 which is written by the famous Chinese science fiction writer named Cixin Liu(刘慈欣).
Sophon is a word amalgamation of
Sophia/sophist/sophisticated, meaning wisdom,
Proton/Electron/Neutron/Photon, meaning particle,
consisting of a supercomputer embedded into a single proton that could fold itself to eleven space dimensions.