{"id":21584648,"url":"https://github.com/aarroyoc/doclog","last_synced_at":"2026-02-25T00:33:50.337Z","repository":{"id":65446452,"uuid":"538102827","full_name":"aarroyoc/doclog","owner":"aarroyoc","description":"DocLog builds documentation from source code in Prolog","archived":false,"fork":false,"pushed_at":"2024-10-29T21:53:11.000Z","size":32,"stargazers_count":22,"open_issues_count":4,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-29T23:49:12.559Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Prolog","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aarroyoc.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":"2022-09-18T12:30:42.000Z","updated_at":"2024-10-29T21:53:15.000Z","dependencies_parsed_at":"2024-08-14T10:47:09.919Z","dependency_job_id":"74640952-d7b6-4b20-a759-d448686cceec","html_url":"https://github.com/aarroyoc/doclog","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/aarroyoc%2Fdoclog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aarroyoc%2Fdoclog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aarroyoc%2Fdoclog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aarroyoc%2Fdoclog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aarroyoc","download_url":"https://codeload.github.com/aarroyoc/doclog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226178436,"owners_count":17585959,"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-24T15:01:24.254Z","updated_at":"2025-10-31T03:02:48.325Z","avatar_url":"https://github.com/aarroyoc.png","language":"Prolog","funding_links":[],"categories":["Prolog"],"sub_categories":[],"readme":"# DocLog\n\nCreate documentation from your Prolog code\n\nExample, Scryer Prolog documentation: https://www.scryer.pl\n\n## How to document your code?\n\nThere are two kind of comments in DocLog: module and predicate.\n\nEach file/module has the option to write a module comment. It will be displayed at the beginning of the page. You can use [Djot](https://djot.net/) inside the comment. The syntax is:\n```\n/**\nCOMMENT\nMORE COMMENT\n*/\n```\n\nPredicate comments start with %% and they're followed by N % comments. Of those lines, the first line comment should be empty. You should indicate in the first line, the name of the predicate, var names and modes. Then you can use [Djot](https://djot.net/) to explain the rest of the predicate.\n\n```\n%% append(L0, L1, L)\n%\n% L is L0 and L1 appended together\n```\n\n## Using Doclog\n\nFirst, clone the repo:\n\n```\n$ git clone https://github.com/aarroyoc/doclog\n$ cd doclog\n```\n\nThen, install the dependencies:\n\n```\n$ make setup\n```\n\nAfter that, you must create a configuration file called `doclog.config.pl`. This file will contain several options required to document your project, and must be in your source directory. Take a look at `scryer.config.pl` for an example file.\n\nWith your config file, you can execute Doclog:\n\n```\n./doclog.sh SOURCE_FOLDER OUTPUT_FOLDER\n```\n\nAnd wait for the docs to be generated!\n\nWhile developing, it might be usefull to rebuild everytime something in the SOURCE\\_FOLDER changed. You can do so, by starting this command:\n\n```\n./watch.sh SOURCE_FOLDER OUTPUT_FOLDER\n```\n\nThere's support for incremental compilation, however, this incremental compilation won't update the sidebars.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faarroyoc%2Fdoclog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faarroyoc%2Fdoclog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faarroyoc%2Fdoclog/lists"}