{"id":19931033,"url":"https://github.com/sphinx-contrib/restbuilder","last_synced_at":"2025-05-03T10:32:20.141Z","repository":{"id":46337610,"uuid":"105162524","full_name":"sphinx-contrib/restbuilder","owner":"sphinx-contrib","description":"A Sphinx builder/writer to output reStructuredText (rst) files","archived":false,"fork":false,"pushed_at":"2021-10-30T09:35:31.000Z","size":151,"stargazers_count":30,"open_issues_count":8,"forks_count":27,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-22T17:17:04.555Z","etag":null,"topics":["documentation","restructuredtext","sphinx-doc","sphinx-extension"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-28T15:00:29.000Z","updated_at":"2024-12-20T18:26:29.000Z","dependencies_parsed_at":"2022-07-22T10:47:46.967Z","dependency_job_id":null,"html_url":"https://github.com/sphinx-contrib/restbuilder","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Frestbuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Frestbuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Frestbuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Frestbuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/restbuilder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252179057,"owners_count":21707107,"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","restructuredtext","sphinx-doc","sphinx-extension"],"created_at":"2024-11-12T23:05:52.936Z","updated_at":"2025-05-03T10:32:19.816Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","readme":".. -*- restructuredtext -*-\n\n=======================\nREADME for reST Builder\n=======================\n\nSphinx_ extension to build reST (reStructuredText_) files.\n\nThis extension is in particular useful to use in combination with the autodoc\nextension to automatically generate documentation for use by any rst parser\n(such as the GitHub wiki).\n\nIn itself, the extension is fairly straightforward -- it takes the parsed reST\nfile from Sphinx_ and outputs it as reST.\n\nRequirements\n============\n\n* Sphinx_ 2.0\n* Python 3.5\n\nSphinx 1.4 - 1.8 and Python 2.7 are partly supported. It does work, but some\nmarkup may not parse correctly.\n\nInstalling\n==========\n\nUsing pip\n---------\n\n::\n\n    pip install sphinxcontrib-restbuilder\n\nManual\n------\n\n::\n\n    git clone https://github.com/sphinx-contrib/restbuilder.git\n    cd restbuilder\n    python setup.py install\n\nIf you want to try reST builder without using the setuptools installer,\nyou can put the reST builder in an extension subdirectory, and adjust\n``sys.path`` to tell Sphinx where to look for it:\n\n- Add the extensions directory to the path in ``conf.py``. E.g.::\n\n    sys.path.append(os.path.abspath('exts'))\n\nUsage\n=====\n\n- Set the builder as a extension in ``conf.py``::\n\n    extensions = ['sphinxcontrib.restbuilder']\n\n- Run sphinx-build with target ``rst``::\n\n    sphinx-build -b rst -c . build/rst\n\nConfiguration\n=============\n\nThe following four configuration variables are defined by sphinxcontrib.restbuilder:\n\n:literal:`rst_file_suffix`\n  This is the file name suffix for generated reST files.  The default is\n  ``\".rst\"``.\n\n:literal:`rst_link_suffix`\n  Suffix for generated links to reST files.  The default is whatever\n  `rst_file_suffix` is set to.\n\n:literal:`rst_file_transform`\n  Function to translate a docname to a filename. \n  By default, returns `docname` + :literal:`rst_file_suffix`.\n\n:literal:`rst_link_transform`:\n  Function to translate a docname to a (partial) URI. \n  By default, returns `docname` + :literal:`rst_link_suffix`.\n\n\nFurther Reading\n===============\n\n.. _Sphinx: http://sphinx-doc.org/\n.. _`sphinx-contrib`: http://bitbucket.org/birkenfeld/sphinx-contrib\n.. _reStructuredText: http://docutils.sourceforge.net/rst.html\n\nFeedback\n========\n\nThe reST builder is in a preliminary state. It's not (yet) widely used, so\nany feedback is particularly welcome.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Frestbuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Frestbuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Frestbuilder/lists"}