{"id":19175961,"url":"https://github.com/astropy/sphinx-astropy","last_synced_at":"2025-04-10T04:59:37.975Z","repository":{"id":28813794,"uuid":"119399685","full_name":"astropy/sphinx-astropy","owner":"astropy","description":"Sphinx functionality for Astropy","archived":false,"fork":false,"pushed_at":"2024-10-10T20:45:58.000Z","size":231,"stargazers_count":5,"open_issues_count":12,"forks_count":17,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-10-29T16:04:36.082Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/astropy.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE.rst","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},"funding":{"github":"numfocus","custom":"https://numfocus.org/donate-to-astropy"}},"created_at":"2018-01-29T15:17:45.000Z","updated_at":"2024-10-10T20:46:03.000Z","dependencies_parsed_at":"2024-04-12T10:20:45.500Z","dependency_job_id":"a73489f7-aa9f-497c-ada7-7a8dc0b6659c","html_url":"https://github.com/astropy/sphinx-astropy","commit_stats":{"total_commits":222,"total_committers":23,"mean_commits":9.652173913043478,"dds":0.7747747747747747,"last_synced_commit":"54421f504c3a5c253a9283c2066043c9dd3adbc4"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astropy%2Fsphinx-astropy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astropy%2Fsphinx-astropy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astropy%2Fsphinx-astropy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astropy%2Fsphinx-astropy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/astropy","download_url":"https://codeload.github.com/astropy/sphinx-astropy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247675972,"owners_count":20977442,"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":"2024-11-09T10:26:33.594Z","updated_at":"2025-04-10T04:59:37.955Z","avatar_url":"https://github.com/astropy.png","language":"Python","funding_links":["https://github.com/sponsors/numfocus","https://numfocus.org/donate-to-astropy"],"categories":[],"sub_categories":[],"readme":"About\n=====\n\n.. image:: https://zenodo.org/badge/119399685.svg\n   :target: https://zenodo.org/badge/latestdoi/119399685\n   :alt: Zenodo DOI\n\n.. image:: https://github.com/astropy/sphinx-astropy/actions/workflows/python-tests.yml/badge.svg\n   :target: https://github.com/astropy/sphinx-astropy/actions/workflows/python-tests.yml\n   :alt: CI Status\n\nThis package serves two purposes: it provides a default Sphinx configuration and set of extensions specific to the Astropy project, and it acts as a meta-package by installing all required Sphinx extensions for the core Astropy package and other packages.\n\nSphinx configuration\n--------------------\n\nThe default Sphinx configuration can be imported by putting:\n\n.. code-block:: python\n\n    from sphinx_astropy.conf import *\n\nat the top of your ``conf.py`` file. You can then override specific settings from this default configuration, such as adding extensions or intersphinx packages. To give a clearer error messages for users, you can instead write:\n\n.. code-block:: python\n\n    try:\n        from sphinx_astropy.conf import *\n    except ImportError:\n        print('ERROR: the documentation requires the sphinx-astropy package to be installed')\n        sys.exit(1)\n\nDependencies/extensions\n-----------------------\n\nInstalling **sphinx-astropy** will automatically install (if not already present):\n\n* `Sphinx \u003chttp://www.sphinx-doc.org\u003e`_\n\n* `astropy-sphinx-theme \u003chttps://github.com/astropy/astropy-sphinx-theme\u003e`_ - the default 'bootstrap' theme use by Astropy and a number of affiliated packages. This goes with `sphinx_astropy.conf.v1`.\n\n* `sphinx-automodapi \u003chttp://sphinx-automodapi.readthedocs.io\u003e`_ - an extension that makes it easy to automatically generate API documentation.\n\n* `sphinx-gallery \u003chttps://sphinx-gallery.readthedocs.io/en/latest/\u003e`_ - an extension to generate example galleries\n\n* `numpydoc \u003chttps://numpydoc.readthedocs.io\u003e`_ - an extension to parse docstrings in NumpyDoc format\n\n* `pillow \u003chttps://pillow.readthedocs.io/en/latest/\u003e`_ - a package to deal with\n  images, used by some examples in the astropy core documentation.\n\n* `pytest-doctestplus \u003chttps://github.com/astropy/pytest-doctestplus/\u003e`_ - providing the 'doctestplus' extension to skip code snippets in narrative documentation.\n\npydata-sphinx-theme (confv2)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nTo use the new `pydata-sphinx-theme` with `sphinx_astropy.conf.v2`, you have to install\nthe optional `[confv2]` dependencies::\n\n    pip install sphinx-astropy[confv2]\n\nThat would pull in the following as well:\n\n* `pydata-sphinx-theme \u003chttps://github.com/pydata/pydata-sphinx-theme/\u003e`_ - a clean, three-column,\n  Bootstrap-based Sphinx theme by and for the `PyData community \u003chttps://pydata.org/\u003e`_.\n\n* `sphinx-copybutton \u003chttps://github.com/executablebooks/sphinx-copybutton\u003e`_ - a small Sphinx\n  extension to add a \"copy\" button to code blocks.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastropy%2Fsphinx-astropy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fastropy%2Fsphinx-astropy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastropy%2Fsphinx-astropy/lists"}