# Espressif Documentation Build System
Esp-docs is a python based wrapper for the documentation building package Sphinx.
It is intended to simplify and extend Sphinx's functionality to better suit what is needed for building documentation for Espressif's development frameworks
Provides:
* Functionality for building documentation for multiple targets (e.g. ESP32 and ESP32-C3) from the same rst source files.
* Sphinx extensions used at Espressif
* Scripts for deploying docs
For a more in-depth guide on how to install, write, and compile documentation please see [ESP-Docs User Guide](https://docs.espressif.com/projects/esp-docs/en/latest/index.html).
Raw data
{
"_id": null,
"home_page": "https://github.com/espressif/esp-docs",
"name": "esp-docs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Espressif",
"author_email": "marius.vikhammer@espressif.com",
"download_url": "https://files.pythonhosted.org/packages/79/11/e688b05f1c29d8bc6ef2d20578654d905a83537caf366fff0ecbd06d94a8/esp_docs-1.10.3.tar.gz",
"platform": null,
"description": "\n# Espressif Documentation Build System\n\nEsp-docs is a python based wrapper for the documentation building package Sphinx.\n\nIt is intended to simplify and extend Sphinx's functionality to better suit what is needed for building documentation for Espressif's development frameworks\n\nProvides:\n * Functionality for building documentation for multiple targets (e.g. ESP32 and ESP32-C3) from the same rst source files.\n * Sphinx extensions used at Espressif\n * Scripts for deploying docs\n\nFor a more in-depth guide on how to install, write, and compile documentation please see [ESP-Docs User Guide](https://docs.espressif.com/projects/esp-docs/en/latest/index.html).\n",
"bugtrack_url": null,
"license": null,
"summary": "Documentation building package used at Espressif",
"version": "1.10.3",
"project_urls": {
"Bug Tracker": "https://github.com/espressif/esp-docs/issues",
"Homepage": "https://github.com/espressif/esp-docs"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f555287fea2c92a73af2747af528fddff1c6750599b106fab2c762c037362b9d",
"md5": "ef8fccfeb6c0a3d60030fb14afd75510",
"sha256": "a00e6439e2e3b8a63c77abceedaa3b333d9575f8608f0484779bb0aaa4de81ee"
},
"downloads": -1,
"filename": "esp_docs-1.10.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef8fccfeb6c0a3d60030fb14afd75510",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 16088994,
"upload_time": "2024-09-05T10:23:29",
"upload_time_iso_8601": "2024-09-05T10:23:29.202984Z",
"url": "https://files.pythonhosted.org/packages/f5/55/287fea2c92a73af2747af528fddff1c6750599b106fab2c762c037362b9d/esp_docs-1.10.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7911e688b05f1c29d8bc6ef2d20578654d905a83537caf366fff0ecbd06d94a8",
"md5": "d4758a7ceb1372103f9244e9c5484608",
"sha256": "00cb25e47ed7e02ec19e3a67670ce8aa04377a727e3873effe5052dfa0fb766c"
},
"downloads": -1,
"filename": "esp_docs-1.10.3.tar.gz",
"has_sig": false,
"md5_digest": "d4758a7ceb1372103f9244e9c5484608",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 16031660,
"upload_time": "2024-09-05T10:23:39",
"upload_time_iso_8601": "2024-09-05T10:23:39.526392Z",
"url": "https://files.pythonhosted.org/packages/79/11/e688b05f1c29d8bc6ef2d20578654d905a83537caf366fff0ecbd06d94a8/esp_docs-1.10.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-05 10:23:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "espressif",
"github_project": "esp-docs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "esp-docs"
}
JSON
