{"id":18304460,"url":"https://github.com/spinalhdl/spinaldoc-rtd","last_synced_at":"2025-10-31T21:30:34.567Z","repository":{"id":38251492,"uuid":"155263879","full_name":"SpinalHDL/SpinalDoc-RTD","owner":"SpinalHDL","description":"The sources of the online SpinalHDL doc","archived":false,"fork":false,"pushed_at":"2024-08-20T05:02:24.000Z","size":964926,"stargazers_count":24,"open_issues_count":26,"forks_count":61,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-08-20T10:57:52.621Z","etag":null,"topics":["documentation","spinalhdl"],"latest_commit_sha":null,"homepage":"https://spinalhdl.github.io/SpinalDoc-RTD/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpinalHDL.png","metadata":{"files":{"readme":"README.rst","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":"2018-10-29T18:49:30.000Z","updated_at":"2024-08-20T10:57:52.622Z","dependencies_parsed_at":"2023-12-21T14:01:05.761Z","dependency_job_id":"84e2675d-474e-4918-a772-ba272bb8cf20","html_url":"https://github.com/SpinalHDL/SpinalDoc-RTD","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpinalHDL%2FSpinalDoc-RTD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpinalHDL%2FSpinalDoc-RTD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpinalHDL%2FSpinalDoc-RTD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpinalHDL%2FSpinalDoc-RTD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpinalHDL","download_url":"https://codeload.github.com/SpinalHDL/SpinalDoc-RTD/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237709856,"owners_count":19354087,"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":["documentation","spinalhdl"],"created_at":"2024-11-05T15:29:00.292Z","updated_at":"2025-10-31T21:30:34.521Z","avatar_url":"https://github.com/SpinalHDL.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=========\nSpinalDoc\n=========\n\nThis is the documentation repository for\n`SpinalHDL \u003chttps://github.com/SpinalHDL/SpinalHDL\u003e`_.\n\nIt is published on\n`spinalhdl.github.io/SpinalDoc-RTD \u003chttps://spinalhdl.github.io/SpinalDoc-RTD/master/index.html\u003e`_.\n\nThere is also a Chinese version on\n`spinalhdl-cn.github.io/SpinalDoc-RTD \u003chttps://spinalhdl-cn.github.io/SpinalDoc-RTD/zh_CN/index.html\u003e`_.\nThis continuous localization version is maintained with the help of `Weblate \u003chttps://hosted.weblate.org/projects/spinaldoc-rtd/\u003e`_.\n\nYou can also find the API documentation on\n`spinalhdl.github.io/SpinalHDL \u003chttps://spinalhdl.github.io/SpinalHDL/dev/spinal/index.html\u003e`_.\n\n\nHow to build this documentation\n===============================\n\nWith venv\n---------\n\nRequirements (system)\n\n* make\n* git\n\nCreate a virtual environment with pipenv (will use the Pipfile for installing the necessary packages)\n\n.. code:: shell\n\n   python3 -m venv .venv\n\nthen you can activate the virtual environment (in bash) and install the dependencies\n\n.. code:: shell\n\n   source .venv/bin/activate\n   pip install -r requirements.txt\n\nand then you can use ``make`` the usual way\n\n.. code:: shell\n\n   make html     # for html\n   make latex    # for latex\n   make latexpdf # for latex (will require latexpdf installed)\n   make          # list all the available output format\n\nall the outputs will be in docs folder (for html: docs/html)\n\nThe Chinese version can be built by\n\n.. code:: shell\n\n   make -e SPHINXOPTS=\"-D language='zh_CN'\" html # for html in Chinese\n\n\nWith Docker\n-----------\n\nRequirements (system):\n\n* docker\n* git\n\nTo create the custom docker image (with python and its dependencies):\n\n.. code:: shell\n\n   docker build -t spinaldoc-rtd .\n\nThen to build the docs:\n\n.. code:: shell\n\n   docker run -it --rm -v $PWD:/docs spinaldoc-rtd\n\nYou can still run custom commands in the docker, for instance to clean:\n\n.. code:: shell\n\n   docker run -it --rm -v $PWD:/docs spinaldoc-rtd make clean\n\nIt is also possible to create the custom docker image to build a pdf (heavier):\n\n.. code:: shell\n\n   docker build -f pdf.Dockerfile -t spinaldoc-pdf .\n\nAnd to run it:\n\n.. code:: shell\n\n   docker run -it --rm -v $PWD:/docs spinaldoc-pdf\n\n\nNative\n------\n\nRequirements (system):\n\n* make\n* git\n\nRequirements (Python 3):\n\n* sphinx\n* sphinx-rtd-theme\n* sphinxcontrib-wavedrom\n* sphinx-multiversion\n\nAfter installing the requirements you can run\n\n.. code:: shell\n\n   make html     # for html\n   make latex    # for latex\n   make latexpdf # for latex (will require latexpdf installed)\n   make          # list all the available output format\n\nyou can create build multiple version of the doc via\n\n.. code:: shell\n\n   sphinx-multiversion source docs/html\n\nin the docs/html there will be a folder with the builded doc for each branch and tag\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspinalhdl%2Fspinaldoc-rtd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspinalhdl%2Fspinaldoc-rtd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspinalhdl%2Fspinaldoc-rtd/lists"}