{"id":17092983,"url":"https://github.com/prkumar/sphinx-reload","last_synced_at":"2025-04-12T22:45:59.509Z","repository":{"id":25821105,"uuid":"106641488","full_name":"prkumar/sphinx-reload","owner":"prkumar","description":"Live preview your Sphinx documentation","archived":false,"fork":false,"pushed_at":"2023-02-01T10:35:42.000Z","size":18400,"stargazers_count":47,"open_issues_count":4,"forks_count":12,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T16:55:04.840Z","etag":null,"topics":["python","sphinx"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prkumar.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}},"created_at":"2017-10-12T03:46:14.000Z","updated_at":"2025-03-09T23:25:53.000Z","dependencies_parsed_at":"2023-02-17T04:30:24.123Z","dependency_job_id":null,"html_url":"https://github.com/prkumar/sphinx-reload","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/prkumar%2Fsphinx-reload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prkumar%2Fsphinx-reload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prkumar%2Fsphinx-reload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prkumar%2Fsphinx-reload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prkumar","download_url":"https://codeload.github.com/prkumar/sphinx-reload/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248565077,"owners_count":21125415,"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":["python","sphinx"],"created_at":"2024-10-14T14:04:05.774Z","updated_at":"2025-04-12T22:45:59.471Z","avatar_url":"https://github.com/prkumar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Sphinx-Reload\n*************\n\n|PyPI Version| |Build Status|\n\n.. image:: demo.gif\n\n\nInstallation\n============\n\nTo install, use ``pip`` (or ``easy_install``):\n\n::\n\n    $ pip install sphinx-reload\n\n\nThe package installs the command-line program ``sphinx-reload``:\n\n::\n\n    $ sphinx-reload --version\n    v0.2.0\n\nGetting Started\n===============\n\nTo begin live previewing your documentation, simply pass the path of your\ndocumentation's root as a command-line argument with ``sphinx-reload``.\nHere's an example assuming your documentation's root is under the current\ndirectory and named ``docs``:\n\n::\n\n    $ sphinx-reload docs/\n\n``sphinx-reload`` will open a preview in a new tab of your favorite browser\nand watch for changes in your documentation's source\nfiles (e.g., any `reStructuredText\n\u003chttp://docutils.sourceforge.net/rst.html\u003e`__ files under the documentation's\nroot).\n\nTo view further usage details, use the script's ``--help`` option:\n\n::\n\n    $ sphinx-reload --help\n\n.. |Build Status| image:: https://travis-ci.org/prkumar/sphinx-reload.svg?branch=master\n   :target: https://travis-ci.org/prkumar/sphinx-reload\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/sphinx-reload.svg\n   :target: https://pypi.python.org/pypi/sphinx-reload\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprkumar%2Fsphinx-reload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprkumar%2Fsphinx-reload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprkumar%2Fsphinx-reload/lists"}