{"id":24838970,"url":"https://github.com/monitor1379/sophon","last_synced_at":"2025-07-09T05:06:49.231Z","repository":{"id":118275418,"uuid":"73625033","full_name":"monitor1379/sophon","owner":"monitor1379","description":"Sophon: Automatic API Markdown Documentation Generation for Python.","archived":false,"fork":false,"pushed_at":"2016-12-03T08:26:17.000Z","size":686,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T04:34:04.868Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://monitor1379.github.io/sophon","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/monitor1379.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-13T15:38:52.000Z","updated_at":"2020-08-31T02:31:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"8f3dfbbd-0478-450e-b264-1dd3de337845","html_url":"https://github.com/monitor1379/sophon","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/monitor1379/sophon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monitor1379%2Fsophon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monitor1379%2Fsophon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monitor1379%2Fsophon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monitor1379%2Fsophon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/monitor1379","download_url":"https://codeload.github.com/monitor1379/sophon/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monitor1379%2Fsophon/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264396640,"owners_count":23601544,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-31T06:36:29.142Z","updated_at":"2025-07-09T05:06:49.216Z","avatar_url":"https://github.com/monitor1379.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sophon: Automatic API Markdown Documentation Generation for Python\n\nMore details about installation and usage of Sophon are in here: [Sophon](https://monitor1379.github.io/sophon).\n\n## What is Sophon?\n\nSophon is a tool that could **automatically generate Markdown-format API documentations** from Python docstring,\njust like **Epydoc** (supports reStructuredText, Javadoc, plaintext)\nand **Napoleon** (Sphinx extension that enables Sphinx to parse both NumPy and Google \nstyle docstrings to reStructuredText).\n\nSophon is written by [Zhenpeng Deng(monitor1379)][1] and licensed under the MIT license.\n\n## Why Sophon?\n\nFeatures:\n \n- **Support different kinds of docstrings.**\n    Sophon mainly supports to parse docstring with the following styles and converts them to Markdown: \n    - Sophon style docstring\n    - (Coming Soon) [Google style][4], the style recommended by [Khan Academy][5]\n    - (Coming Soon) [NumPy style][6]\n    \n    Sophon also supports to parse every docstring in Python project,\n    including docstrings on: `classes`, `methods` and `functions`\n    (`modules`, `attributes` and `variables` will be supported soon)\n    \n    \n- **Output Markdown format documentations.**\n    Markdown is a way to write contents for the web.\n    Unlike cumbersome word processing applications or other markup languages with complicated syntax,\n    text written in Markdown can be easy to read, easy to write and easily shared for between computers, \n    mobile phones, and people. \n    Though it does not do anything fancy like change the font size, color or type by itself,\n    it has enough stuffs to write an API documentation for your python projects.\n    \n    Another important reason of choosing Markdown is that there are some remarkable tools for Markdown\n    to build beautiful documentations or blogs such as\n    [MkDocs(Project documentation with Markdown)][2] or [Hexo(A fast, simple \u0026 powerful blog framework)][3].\n   \n- **Easily and Highly customizable.**\n    Sophon uses [YAML: YAML Ain't Markup Language][7] as the format of configuration file.\n    By configuring and providing Markdown template files, you can freely organize your documentation,\n    or open some advanced features such as linking API to source files deposited on GitHub repositories.\n\n- **One-Command build.** \n    you only need one command to build you API documentation.\n\n\nYou can find more details in **[User Guide/Installation](user_guide/installation.md)** or\n**[User Guide/Getting Started](user_guide/getting_started.md)**.\n\n\n## What does \"Sophon\" mean?\n\n**Sophon** is the official translation of \"**智子**\" in 《Rememberance of Earth's Past II: The Dark Forest》\nwhich is written by the famous Chinese science fiction writer named **Cixin Liu(刘慈欣)**.\n\n\n**Sophon** is a word amalgamation of `Sophia/sophist/sophisticated`, meaning **wisdom**, \nand `Proton/Electron/Neutron/Photon`, meaning **particle**,\nconsisting of a supercomputer embedded into a single proton that could fold itself to eleven space dimensions.\n\n\n[1]: https://github.com/monitor1379\n[2]: http://www.mkdocs.org\n[3]: https://hexo.io\n[4]: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google\n[5]: https://sites.google.com/a/khanacademy.org/forge/for-developers/styleguide/python#TOC-Docstrings\n[6]: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html#example-numpy\n[7]: http://www.yaml.org/\n[8]: user_guide/sophon_style_python_docstrings\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonitor1379%2Fsophon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmonitor1379%2Fsophon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonitor1379%2Fsophon/lists"}