{"id":25208121,"url":"https://github.com/1010code/sphinx-tutorial","last_synced_at":"2025-04-05T04:19:20.985Z","repository":{"id":253776839,"uuid":"844496506","full_name":"1010code/sphinx-tutorial","owner":"1010code","description":"一步步教你如何利用 Sphinx 撰寫專業文檔並部署到 Read the Docs","archived":false,"fork":false,"pushed_at":"2024-08-24T02:59:30.000Z","size":10522,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-10T12:18:51.190Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://medium.com/@andy6804tw/sphinx-入門指南-python-自動化文檔生成工具-6a4affd5dba4","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/1010code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-08-19T11:35:19.000Z","updated_at":"2024-08-24T03:53:00.000Z","dependencies_parsed_at":"2024-08-24T03:42:11.092Z","dependency_job_id":null,"html_url":"https://github.com/1010code/sphinx-tutorial","commit_stats":null,"previous_names":["1010code/sphinx-tutorial"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1010code%2Fsphinx-tutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1010code%2Fsphinx-tutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1010code%2Fsphinx-tutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1010code%2Fsphinx-tutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/1010code","download_url":"https://codeload.github.com/1010code/sphinx-tutorial/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247285596,"owners_count":20913843,"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-02-10T12:18:52.801Z","updated_at":"2025-04-05T04:19:20.963Z","avatar_url":"https://github.com/1010code.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"reStructuredText（RST、ReST或reST）是一種用於文字資料的檔案格式，主要用於Python 程式語言社群的技術文件。 reStructuredText. reStructuredText logo. 副檔名 .rst.\n\n## Sphinx\nSphinx是一個功能強大的文件產生器，具有許多用於編寫技術文件的強大功能，包括：產生網頁，可列印的PDF，電子閱讀器的文檔（ePub），以及更多來自相同來源的文檔。可以使用reStructuredText或Markdown 編寫文檔。\n\n\n## 安裝相依套件\n使用pip安裝軟體包\n- Sphinx：用於生成專案的技術文檔。\n- sphinx_rtd_theme：一個專為 Read the Docs 設計的乾淨主題。\n- myst_parser：允許在 Sphinx 中使用 Markdown 格式文檔的解析器。\n```\npip install sphinx sphinx_rtd_theme myst_parser\n```\n\n## 建立專案\n```\nmkdir wiki\ncd wiki\nsphinx-quickstart\n```\n\n![](https://images.ukx.cn/abcdocker/cluswqb0yfgcxwwzs73ay1fy/image_1d5ble14g12i35jd15mv6ja1hbr2i.png)\n\n## 編譯\n\n```\nmake clean\nmake html\n```\n\n\n### markdown語法編寫\n\n```\npip install myst_parser\n```\nThen in your conf.py:\n```\nextensions = ['myst_parser']\n```\n\n### 輸出PDF\n參考\n- [使用rst2pdf轉PDF](https://chwang12341.medium.com/coding%E8%B5%B7%E4%BE%86-python%E5%B7%A5%E5%85%B7-sphinx%E6%93%8D%E4%BD%9C%E6%95%99%E5%AD%B8-%E4%BA%8C-%E5%A6%82%E4%BD%95%E5%B0%87restructured-text-rst-%E6%96%87%E4%BB%B6%E8%BD%89%E6%8F%9B%E6%88%90pdf-latex%E8%88%87rst2pdf%E6%96%B9%E6%B3%95%E6%95%99%E5%AD%B8-6408bd4d3a3e)\n\n\n\n## Reference\n- [Sphinx操作教學介紹](https://chwang12341.medium.com/coding%E8%B5%B7%E4%BE%86-python%E5%B7%A5%E5%85%B7-sphinx%E6%93%8D%E4%BD%9C%E6%95%99%E5%AD%B8-%E4%BA%8C-%E5%A6%82%E4%BD%95%E5%B0%87restructured-text-rst-%E6%96%87%E4%BB%B6%E8%BD%89%E6%8F%9B%E6%88%90pdf%E6%96%87%E4%BB%B6-latex%E8%88%87rst2pdf%E6%96%B9%E6%B3%95%E6%95%99%E5%AD%B8-4f017bf857a4)\n- [Markdown with Sphinx Quick Start](https://cerodell.github.io/sphinx-quickstart-guide/build/html/markdown.html)\n- [Sphinx建立部落格](https://i4t.com/3587.html)\n- [Sphinx + MyST + Markdown for Static HTML Pages](https://www.lucasshen.com/notes/sphinx-md2html/sphinx-md2html)\n\nreStructuredText（RST、ReST或reST）是一種用於文字資料的檔案格式，主要用於Python 程式語言社群的技術文件。 reStructuredText. reStructuredText logo. 副檔名 .rst.\n\n## Sphinx\nSphinx是一個功能強大的文件產生器，具有許多用於編寫技術文件的強大功能，包括：產生網頁，可列印的PDF，電子閱讀器的文檔（ePub），以及更多來自相同來源的文檔。可以使用reStructuredText或Markdown 編寫文檔。\n\n\n## 安裝相依套件\n使用pip安裝軟體包\n\n```\npip install sphinx sphinx - autobuild sphinx_rtd_theme\n```\n\n## 建立專案\n```\nmkdir wiki\ncd wiki\nsphinx-quickstart\n```\n\n![](https://images.ukx.cn/abcdocker/cluswqb0yfgcxwwzs73ay1fy/image_1d5ble14g12i35jd15mv6ja1hbr2i.png)\n\n## 編譯\n\n```\nmake clean\nmake html\n```\n\n\n### markdown語法編寫\n\n```\npip install myst_parser\n```\nThen in your conf.py:\n```\nextensions = ['myst_parser']\n```\n\n### 輸出PDF\n參考\n- [使用rst2pdf轉PDF](https://chwang12341.medium.com/coding%E8%B5%B7%E4%BE%86-python%E5%B7%A5%E5%85%B7-sphinx%E6%93%8D%E4%BD%9C%E6%95%99%E5%AD%B8-%E4%BA%8C-%E5%A6%82%E4%BD%95%E5%B0%87restructured-text-rst-%E6%96%87%E4%BB%B6%E8%BD%89%E6%8F%9B%E6%88%90pdf-latex%E8%88%87rst2pdf%E6%96%B9%E6%B3%95%E6%95%99%E5%AD%B8-6408bd4d3a3e)\n\n\n\n## Reference\n- [Sphinx操作教學介紹](https://chwang12341.medium.com/coding%E8%B5%B7%E4%BE%86-python%E5%B7%A5%E5%85%B7-sphinx%E6%93%8D%E4%BD%9C%E6%95%99%E5%AD%B8-%E4%BA%8C-%E5%A6%82%E4%BD%95%E5%B0%87restructured-text-rst-%E6%96%87%E4%BB%B6%E8%BD%89%E6%8F%9B%E6%88%90pdf%E6%96%87%E4%BB%B6-latex%E8%88%87rst2pdf%E6%96%B9%E6%B3%95%E6%95%99%E5%AD%B8-4f017bf857a4)\n- [Markdown with Sphinx Quick Start](https://cerodell.github.io/sphinx-quickstart-guide/build/html/markdown.html)\n- [Sphinx建立部落格](https://i4t.com/3587.html)\n- [Sphinx + MyST + Markdown for Static HTML Pages](https://www.lucasshen.com/notes/sphinx-md2html/sphinx-md2html)\n- [Host your documentation on ReadTheDocs : Step-by-step guide](https://www.youtube.com/watch?v=PO4Zd-6a6fAhttps://www.youtube.com/watch?v=PO4Zd-6a6fA)# sphinx-tutorial\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1010code%2Fsphinx-tutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F1010code%2Fsphinx-tutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1010code%2Fsphinx-tutorial/lists"}