{"id":15360374,"url":"https://github.com/oriolabril/sphinx-primer","last_synced_at":"2025-04-15T08:17:15.766Z","repository":{"id":55612427,"uuid":"414381147","full_name":"OriolAbril/sphinx-primer","owner":"OriolAbril","description":"A sphinx primer for ArviZ and PyMC contributors","archived":false,"fork":false,"pushed_at":"2022-12-08T15:34:02.000Z","size":579,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T08:17:06.218Z","etag":null,"topics":["arviz","pymc","pymc3","sphinx","sphinx-doc"],"latest_commit_sha":null,"homepage":"https://sphinx-primer.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OriolAbril.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}},"created_at":"2021-10-06T21:58:27.000Z","updated_at":"2023-01-06T01:19:07.000Z","dependencies_parsed_at":"2023-01-25T16:01:22.284Z","dependency_job_id":null,"html_url":"https://github.com/OriolAbril/sphinx-primer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OriolAbril%2Fsphinx-primer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OriolAbril%2Fsphinx-primer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OriolAbril%2Fsphinx-primer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OriolAbril%2Fsphinx-primer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OriolAbril","download_url":"https://codeload.github.com/OriolAbril/sphinx-primer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249031816,"owners_count":21201357,"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":["arviz","pymc","pymc3","sphinx","sphinx-doc"],"created_at":"2024-10-01T12:49:37.636Z","updated_at":"2025-04-15T08:17:15.733Z","avatar_url":"https://github.com/OriolAbril.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## A sphinx primer for ArviZ and PyMC contributors\n\nThis repo outlines the key uses and structure of sphinx within ArviZ and\nPyMC documentation. Some parts will therefore be specific to these projects,\nbut the bulk of the content will be applicable to any MyST first project.\n\nThe content is written in `.md` MyST files and rendered with sphinx in\norder to also showcase it's capabilities and serve as example.\nIt does have one peculiarity with respect to most sphinx sites however,\nthe content is structured in small pages so that when combined with\nthe left/right key navigation it has the feel of a presentation.\n\nThe website is published at https://sphinx-primer.readthedocs.io/en/latest/\n\n#### Build the webpage locally\nThe content is written as a sphinx website, with the key navigation controls\nactivated so it can be read as a presentation too. To build the page you'll\nneed to install the `requirements-docs.txt` and run:\n\n    make html\n\nAfter that, open the `_build/index.html` file with your preferred browser.\n\n#### Manage translations\nTo manage translations you should follow the [guide on readthedocs documentation](https://docs.readthedocs.io/en/stable/guides/manage-translations-sphinx.html)\nwith some variations.\n\n1. Translation is set up with Transifex: https://www.transifex.com/arviz/sphinx-primer-website. You\n   should ignore the manual translation section.\n1. `sphinx-build` should not be called manually. Use the equivalent `make` commands:\n\n    ```bash\n    make gettext         # to generate text sources to be translated\n    make html \u003clocale\u003e   # to build non-english docs\n    ```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foriolabril%2Fsphinx-primer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foriolabril%2Fsphinx-primer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foriolabril%2Fsphinx-primer/lists"}