{"id":41371120,"url":"https://github.com/openfisca/openfisca-doc","last_synced_at":"2026-01-23T09:31:33.863Z","repository":{"id":1375327,"uuid":"42248086","full_name":"openfisca/openfisca-doc","owner":"openfisca","description":"User guide of OpenFisca","archived":false,"fork":false,"pushed_at":"2026-01-11T11:10:40.000Z","size":18950,"stargazers_count":19,"open_issues_count":13,"forks_count":23,"subscribers_count":20,"default_branch":"main","last_synced_at":"2026-01-11T15:55:53.958Z","etag":null,"topics":["documentation","gitbook","hacktoberfest","openfisca"],"latest_commit_sha":null,"homepage":"https://openfisca.org/doc","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openfisca.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2015-09-10T14:03:10.000Z","updated_at":"2026-01-11T11:10:43.000Z","dependencies_parsed_at":"2025-03-15T19:26:58.374Z","dependency_job_id":"f438e786-1765-4cf7-acab-8392b3cf3c08","html_url":"https://github.com/openfisca/openfisca-doc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/openfisca/openfisca-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfisca%2Fopenfisca-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfisca%2Fopenfisca-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfisca%2Fopenfisca-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfisca%2Fopenfisca-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openfisca","download_url":"https://codeload.github.com/openfisca/openfisca-doc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfisca%2Fopenfisca-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28686402,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T05:48:07.525Z","status":"ssl_error","status_checked_at":"2026-01-23T05:48:07.129Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","gitbook","hacktoberfest","openfisca"],"created_at":"2026-01-23T09:31:33.097Z","updated_at":"2026-01-23T09:31:33.851Z","avatar_url":"https://github.com/openfisca.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenFisca Doc\n\n[OpenFisca](http://openfisca.org/doc/) is versatile and free micro-simulation software. This repository contains the source code of its [online documentation](http://openfisca.org/doc/).\n\n## Installation\n\nThis documentation is built with [Sphinx](https://www.sphinx-doc.org/), a Python documentation generator. You will thus need to install a [Python runtime](https://www.python.org/downloads/) to build it. The version to install is specified in the `runtime.txt` file.\n\nIn order to avoid conflicting dependencies with other projects on your local machine, it is recommended to install its dependencies in a virtual environment. To create a virtual environment, run:\n\n```sh\npython3 -m venv .venv\nsource .venv/bin/activate\n```\n\nTo install dependencies, run:\n\n```sh\nmake install\n```\n\n## Build\n\nTo build the HTML documentation, run:\n\n```sh\nmake html\n```\n\nThe HTML output will be generated in the `build/html` directory.\n\n## Dev\n\nTo serve the documentation in dev mode, run:\n\n```sh\nmake dev\n```\n\nThe documentation will be served on `http://127.0.0.1:8000`\n\n## Test\n\nTo test the documentation, run:\n\n```sh\nmake test\n```\n\nThis will also lint the source files using [Markdownlint](https://github.com/DavidAnson/markdownlint), for which you will need [Node](https://nodejs.org) and NPM.\n\n## Autoformat\n\nIf `make lint` gives you errors, you can try running the following command to automatically format your contributions according to the existing conventions:\n\n```sh\nmake format\n```\n\n## Fixing the doc\n\nIf the tests fail, here's what you can do:\n\nIf the errors also concern OpenFisca-Core, please take a look at the [README](https://github.com/openfisca/openfisca-core/blob/master/README.md).\n\nIf not, clone \u0026 install the documentation:\n\n```sh\ngit clone https://github.com/openfisca/openfisca-doc\nmake install\n```\n\nCreate a branch to correct the problems:\n\n```sh\ngit checkout -b fix-doc\n```\n\nFix the offending problems. You can test-drive your fixes by checking that each change works as expected:\n\n```sh\nmake test\n```\n\nCommit at each step, so you don't accidentally lose your progress:\n\n```sh\ngit add -A \u0026\u0026 git commit -m \"Fixed missing doctree\"\n```\n\nOnce you're done, push your changes:\n\n```sh\ngit push origin `git branch --show-current`\n```\n\nFinally, open a [pull request](https://github.com/openfisca/openfisca-doc/compare/main...fix-doc).\n\nThat's it! 🙌\n\n## Using icons\n\nYou can use icons by choosing one from [Lucide](https://lucide.dev) and adapting the code `\u003ci icon-name=\"$ICON_NAME\"\u003e\u003c/i\u003e` with the relevant icon name.\n\n## Deploy\n\nThe documentation is built as a static website on GitHub Actions with Sphinx. The built files are committed and pushed to the `doc` folder of the GitHub Pages-published branch of the `openfisca.org` repository.\n\nOpenFisca-Core triggers a deployment on the Doc repository whenever a new Core version is deployed, to ensure that the Python and Web API auto-generated documentations are up to date. This is done with [`workflow_dispatch`](https://docs.github.com/en/rest/actions/workflows?apiVersion=2022-11-28#create-a-workflow-dispatch-event--fine-grained-access-tokens) using a personal access token of @openfisca-bot. This personal access token has a maximum lifetime of one year, and will thus need to be updated every year.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfisca%2Fopenfisca-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenfisca%2Fopenfisca-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfisca%2Fopenfisca-doc/lists"}