{"id":20408339,"url":"https://github.com/phpspec/phpspec-docs","last_synced_at":"2025-04-12T15:22:07.157Z","repository":{"id":2138898,"uuid":"3082826","full_name":"phpspec/phpspec-docs","owner":"phpspec","description":"PHPSpec Documentation","archived":false,"fork":false,"pushed_at":"2012-02-25T06:37:59.000Z","size":175,"stargazers_count":18,"open_issues_count":0,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-26T09:51:16.287Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.phpspec.net/documentation","language":"Python","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/phpspec.png","metadata":{"files":{"readme":"README","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}},"created_at":"2012-01-01T14:53:14.000Z","updated_at":"2019-10-28T21:20:08.000Z","dependencies_parsed_at":"2022-08-28T09:40:07.753Z","dependency_job_id":null,"html_url":"https://github.com/phpspec/phpspec-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpspec%2Fphpspec-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpspec%2Fphpspec-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpspec%2Fphpspec-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpspec%2Fphpspec-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phpspec","download_url":"https://codeload.github.com/phpspec/phpspec-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248586464,"owners_count":21129045,"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-15T05:30:13.885Z","updated_at":"2025-04-12T15:22:07.135Z","avatar_url":"https://github.com/phpspec.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Contributing to documentation\n=============================\n\nIntro\n-----\n\nIt is good everyone contributes with documentation.\nWe use sphinx and some custom styling to have offline/online documentation and automate things so that anyone can easily write rst format which is almost like markdown to write up documentation for just about anything.\n\n``rst`` extension stands for restructured format. This short page is written in ``rst`` for your example.\n\nSetting things up\n-----------------\n\nI follow the instructions from this `link \u003chttp://symfony.com/doc/current/contributing/documentation/format.html\u003e`_.\n\nWhich basically tells us to install with the following command:\n\n``$ sudo easy_install -U Sphinx``\n\nHow to contribute\n-----------------\n\nTo clone the doc repos do:\n\n.. code-block:: bash\n\n    $ git clone github.com/phpspec/phpspec-docs.git\n\nDo your changes, commit, and push to your own fork on github, then send a PR to the main repo.\n\nHow to compile\n--------------\n\nTo test or have an off line version of documentation you will just run:\n\n.. code-block:: bash\n\n    $ make html\n\nMake sure your syntax is correct by following the error messages if any.\n\nThe idea is that everything needs to get documented properly as it is very easy to write rst on the fly.\n\nThat is it! PHPSpec FTW!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpspec%2Fphpspec-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphpspec%2Fphpspec-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpspec%2Fphpspec-docs/lists"}