{"id":17465187,"url":"https://github.com/dusktreader/sphinx-view","last_synced_at":"2025-04-09T22:22:51.358Z","repository":{"id":46677269,"uuid":"75989332","full_name":"dusktreader/sphinx-view","owner":"dusktreader","description":"View your rendered Sphinx or ReStrucutredText documents in a browswer","archived":false,"fork":false,"pushed_at":"2021-09-30T17:49:21.000Z","size":78,"stargazers_count":3,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T14:05:05.717Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://sphinx-view.readthedocs.io/en/latest/","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/dusktreader.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.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}},"created_at":"2016-12-09T01:19:31.000Z","updated_at":"2022-06-23T20:11:48.000Z","dependencies_parsed_at":"2022-09-03T21:13:01.435Z","dependency_job_id":null,"html_url":"https://github.com/dusktreader/sphinx-view","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dusktreader%2Fsphinx-view","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dusktreader%2Fsphinx-view/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dusktreader%2Fsphinx-view/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dusktreader%2Fsphinx-view/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dusktreader","download_url":"https://codeload.github.com/dusktreader/sphinx-view/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248120696,"owners_count":21050995,"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-10-18T11:09:03.717Z","updated_at":"2025-04-09T22:22:51.335Z","avatar_url":"https://github.com/dusktreader.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image::  https://badge.fury.io/py/sphinx-view.svg\n   :target: https://badge.fury.io/py/sphinx-view\n   :alt:    Latest Published Version\n\n.. image::  https://travis-ci.org/dusktreader/py-buzz.svg?branch=integration\n   :target: https://travis-ci.org/dusktreader/py-buzz\n   :alt:    Build Status\n\n.. image::  https://readthedocs.org/projects/sphinx-view/badge/?version=latest\n   :target: http://sphinx-view.readthedocs.io/en/latest/?badge=latest\n   :alt:    Documentation Build Status\n\n*************\n sphinx-view\n*************\n\n---------------------------------------------------------------------\nView your rendered Sphinx or ReStrucutredText documents in a browser\n---------------------------------------------------------------------\n\nIf you've ever done much work with Sphinx (or any ReStructuredText) documents,\nyou know how important it is to regularly check how they look when rendered\ninto html. Often, you get your formatting wrong or introduce a syntax error.\nConstantly running sphinx-build by hand is really annoying.\n\nThere is a very nice tool called\n`restview \u003chttps://github.com/mgedmin/restview\u003e`_ that can be used to view\nReStructuredText files, but it doesn't support all the sphinx keywords and\nfeatures. Furthermore, it doesn't render with a style\n\nThe sphinx-view application automatically renders the documents using the\n'alabaster' theme. It renders them using Sphinx itself. It is even capable of\nrendering an entire directory at once and producing a full html page with\nnavigation between sub-pages. This is very handy if, for instance, you are\nediting the ``docs`` folder of a python project.\n\nIn addition, sphinx-view will watch for changes to the documents, rebuild the\npages, and refresh the browser any time you save the documents you are viewing.\n\nSuper-quick Start\n-----------------\n - requirements: `python3.4` or greater\n - install through pip: `$ pip install sphinx-view`\n - view a document: `$ sphinx-view README.rst`\n\nFull Documentation\n------------------\n - `spinx-view documentation home \u003chttp://sphinx-view.readthedocs.io\u003e`_\n - `raw reStructuredText docs\n   \u003chttps://github.com/dusktreader/sphinx-view/tree/master/docs\u003e`_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdusktreader%2Fsphinx-view","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdusktreader%2Fsphinx-view","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdusktreader%2Fsphinx-view/lists"}