{"id":15937058,"url":"https://github.com/fedebenelli/fordoctest","last_synced_at":"2025-03-25T07:30:43.529Z","repository":{"id":221741430,"uuid":"754927375","full_name":"fedebenelli/fordoctest","owner":"fedebenelli","description":"Assure standarized Fortran documentation with tets!","archived":false,"fork":false,"pushed_at":"2024-02-19T22:39:01.000Z","size":489,"stargazers_count":4,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-19T09:40:58.608Z","etag":null,"topics":["documentation","documentation-tool","ford","fortran","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fedebenelli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2024-02-09T03:20:40.000Z","updated_at":"2024-02-19T19:26:23.000Z","dependencies_parsed_at":"2024-02-19T23:36:19.925Z","dependency_job_id":null,"html_url":"https://github.com/fedebenelli/fordoctest","commit_stats":null,"previous_names":["fedebenelli/fordoctest"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedebenelli%2Ffordoctest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedebenelli%2Ffordoctest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedebenelli%2Ffordoctest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedebenelli%2Ffordoctest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fedebenelli","download_url":"https://codeload.github.com/fedebenelli/fordoctest/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245418107,"owners_count":20612061,"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","documentation-tool","ford","fortran","python"],"created_at":"2024-10-07T04:41:58.738Z","updated_at":"2025-03-25T07:30:43.188Z","avatar_url":"https://github.com/fedebenelli.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fordoctest\nAssure Fortran documentation consistence.\n\n## Motivation\nAs a project increases in size, it is harder to track the quality of the present\ncode. In the case of functionality unit testing and coverage metrics can be\nenough to ensure there are no problems. But keeping track of correct\ndocumentation needs even more meticulous work, external tools can be used to\nhelp this process (like ![pydoctest](https://github.com/jepperaskdk/pydoctest))\nin Python. `fordoctest` aims to be an equivalent tool for Fortran documentation.\n\n\n## What does it do?\n\n### Running\n\n```bash\nfordoctest \u003cford_project_file\u003e [ford_flags]\n```\n\nRight now `fordoctest` is in a pre-alpha state, it will check on all the source\nfiles included in a FORD file and send a warning if any of the following cases\noccur:\n\n- More than one module per-file\n- Undocumented:\n    - Isolated procedures\n    - Modules\n    - Modules procedures\n    - Procedures arguments\n\nThe output of `fordoctest will be something like:\"\n\n![example output](docs/media/example_warnings.png)\n\n### What it _aims_ to do\n`fordoctest` aims to be a complete tool used in Fortran projects CI systems that\ncan assure that all the code is correctly documented, and maybe also include\nextra checks like file headers, file naming checks, usage with other tools\nbeside FORD, like Doxygen and Sphinx.  We'll consider `fordoctest` to be in\nbeta-stage once:\n\n- [ ] It becames FORD agnostic (right now it fully depends on the FORD cli\n      parser so it's hard to easy add up methods)\n- [ ] Includes documentation checks of all the different kinds entities (like\n      not included yet, derived types)\n- [ ] Include documentation restrictions (like forcing imperative verbs in a \n      procedure documentation)\n- [ ] Fully tested with coverage of at least 90%\n\n## Installation\nSince this is still an alpha release, we haven't yet released an installable\non PyPI, but the development version can be installed with `pip` with:\n\n```bash\npip install git+ssh://git@github.com/fedebenelli/fordoctest.git\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedebenelli%2Ffordoctest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffedebenelli%2Ffordoctest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedebenelli%2Ffordoctest/lists"}