{"id":28549433,"url":"https://github.com/behat/docs","last_synced_at":"2025-07-12T12:36:10.261Z","repository":{"id":16880504,"uuid":"19641020","full_name":"Behat/docs","owner":"Behat","description":"Behat documentation repository","archived":false,"fork":false,"pushed_at":"2025-06-19T14:02:06.000Z","size":1457,"stargazers_count":27,"open_issues_count":11,"forks_count":68,"subscribers_count":7,"default_branch":"v3.0","last_synced_at":"2025-06-19T15:19:50.827Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://behat.org","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Behat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2014-05-10T12:36:01.000Z","updated_at":"2025-06-19T14:02:03.000Z","dependencies_parsed_at":"2024-10-26T12:43:22.431Z","dependency_job_id":"364f55e6-29d8-4425-8ac9-56077b00fcda","html_url":"https://github.com/Behat/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Behat/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Behat%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Behat%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Behat%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Behat%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Behat","download_url":"https://codeload.github.com/Behat/docs/tar.gz/refs/heads/v3.0","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Behat%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263848852,"owners_count":23519527,"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":"2025-06-10T02:10:14.528Z","updated_at":"2025-07-06T04:31:19.392Z","avatar_url":"https://github.com/Behat.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation \u0026 web content for docs.behat.org\n\nThis repo holds the content for https://docs.behat.org/, which is built and hosted on [Read the Docs Community](https://about.readthedocs.com/) (RtD).\nhttps://behat.org and https://www.behat.org both redirect to this site.\n\nAt the moment, RtD does not feed build status back to GitHub for builds on a project's main branch(es). Instead, you\ncan find build history for each version on RtD.\n\n| Version | Status                                                                                                                                                                        | Docs URL                          | Build dashboard                                                                                   |\n|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|---------------------------------------------------------------------------------------------------|\n| v2.5    | [![Documentation Status](https://readthedocs.org/projects/behat/badge/?version=v2.5\u0026style=for-the-badge)](https://docs.behat.org/en/latest/?badge=v2.5)                       | https://docs.behat.org/en/v2.5/   | [v2.5 build history](https://app.readthedocs.org/projects/behat/builds/?version__slug=v2.5)       |\n| v3.0    | [![Documentation Status](https://readthedocs.org/projects/behat/badge/?version=v3.0\u0026style=for-the-badge)](https://docs.behat.org/en/latest/?badge=v3.0)                       | https://docs.behat.org/en/v3.0/   | [v3.0 build history](https://app.readthedocs.org/projects/behat/builds/?version__slug=v3.0)       |\n| latest* | [![Documentation Status](https://readthedocs.org/projects/behat/badge/?version=latest\u0026style=for-the-badge)](https://docs.behat.org/en/latest/?badge=v3.0\u0026style=for-the-badge) | https://docs.behat.org/en/latest/ | [\"latest\" build history](https://app.readthedocs.org/projects/behat/builds/?version__slug=latest) |\n\n\u003e \\* the \"latest\" version is currently also based off the v3.0 branch, but is a separate build on RTD.\n\n## Project structure\n\nThe site is built using [sphinx](https://www.sphinx-doc.org/en/master/index.html), a python-based documentation\ngenerator based on reStructuredText (.rst) or MyST Markdown (.md) files. Most content is populated in these files.\n\nreStructuredText is similar to Markdown, with some differences. The following resources may be useful:\n\n* RtD's [Getting started with RST tutorial](https://sphinx-tutorial.readthedocs.io/step-1/)\n* The [Spinx reStructuredText primer](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)\n* @waldyrious' [browser-based RST playground](https://waldyrious.net/rst-playground/)\n\nSphinx takes these .rst/.md source files and renders them into the final HTML site with the custom `borg` theme. You'll\nfind the templates and resources for this under the `_themes/borg` directory. The theme provides the overall page\nlayout, as well as features such as automatic contents pages and navigation.\n\n## Previewing on GitHub\n\nThe GitHub web interface natively supports rendering both reStructuredText and Markdown files. For simple changes, this\nis often the quickest way to check the formatting of your contribution. Custom sphinx tags \u0026 metadata (including some\nnavigation tags \u0026 internal links) will not be rendered, but the main content should appear roughly as it will in the\nbuilt version.\n\n## Building locally\n\nFor more significant changes, you may want to build the full docs site locally. For this, you will need python, sphinx\nand the relevant dependencies. \n\nThe easiest solution may be to use a temporary docker container. In this repository you will find a `Dockerfile` \nand a `docker-compose.yml` file that will let you do that easily.\n\nYou can run a one-time build:\n\n```bash\n# Launch a docker container with the right dependencies and run the site build command\n# This will build the container if needed, using the Dockerfile\ndocker compose run --rm read-the-docs-builder build\n\n# The docs will be generated into _build/html\n# Check the CLI output for any errors\n```\n\nOr you can serve the docs locally over HTTP and rebuild them automatically as you make changes:\n\n```bash\n# By default, the docs will be served on port 8000 but you can specify a custom port\nSPHINX_PORT=8129 docker compose up --remove-orphans\n\n# Browse to http://localhost:8129 (or your specified SPHINX_PORT) to see the built docs.\n# They will re-build and refresh in the browser each time you save changes.\n\n# The docs will also be generated statically into _build/html\n```\n\n\nIf you encounter problems, start by looking at the logs of the latest build on Read the Docs to see the commands that\nwere executed. It's possible that this README has got out of date with later changes to the build process.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbehat%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbehat%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbehat%2Fdocs/lists"}