{"id":16674472,"url":"https://github.com/settermjd/sphinx-to-antora-migrator","last_synced_at":"2025-10-08T00:22:59.947Z","repository":{"id":141498597,"uuid":"126317142","full_name":"settermjd/sphinx-to-antora-migrator","owner":"settermjd","description":"This is a small repo that provides code for migrating a Sphinx-Doc installation to Antora","archived":false,"fork":false,"pushed_at":"2018-09-26T11:47:05.000Z","size":6807,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-13T03:16:15.065Z","etag":null,"topics":["antora","php","sphinx-doc","sphinx-documentation","writethedocs"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/settermjd.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":"2018-03-22T10:16:32.000Z","updated_at":"2024-10-03T18:58:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"b6183f72-cdc1-485c-b740-22d5d1fdb2f4","html_url":"https://github.com/settermjd/sphinx-to-antora-migrator","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/settermjd/sphinx-to-antora-migrator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/settermjd%2Fsphinx-to-antora-migrator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/settermjd%2Fsphinx-to-antora-migrator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/settermjd%2Fsphinx-to-antora-migrator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/settermjd%2Fsphinx-to-antora-migrator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/settermjd","download_url":"https://codeload.github.com/settermjd/sphinx-to-antora-migrator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/settermjd%2Fsphinx-to-antora-migrator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278868614,"owners_count":26060006,"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","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["antora","php","sphinx-doc","sphinx-documentation","writethedocs"],"created_at":"2024-10-12T12:43:19.082Z","updated_at":"2025-10-08T00:22:59.929Z","avatar_url":"https://github.com/settermjd.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sphinx-Doc to Antora Migration Tool\n\nThis is a small repository that provides tools for migrating a [Sphinx-Doc](http://www.sphinx-doc.org/en/master/) installation to [Antora](https://antora.org). It’s written in PHP, as the tool was written while working at ownCloud (the vast majority of ownCloud’s code is written in PHP).\nGiven that, it makes sense to keep using PHP. If you want to port it to another language, please feel free.\n\n## What is it?\n\nThe tool is a command-line utility,provided as a PHP Phar archive, that provides a range of commands for exporting a Sphinx-Doc installation to Antora. Currently, there is only one supported command; this is `navigation:build-from-files`, which builds an Antora (AsciiDoc) navigation file, from a list of AsciiDoc files.\n\n## Installation\n\nThe tool is provided both as code, and as a pre-packaged Phar file. So to install it, all you need is PHP, at least version 7.1 or higher. If you want to re-build the Phar archive, then you have two choices:\n\n### 1. Via GNU Make\n\nTo use GNU Make to rebuild the Phar archive, run `make rebuild-phar`. When built, the Phar archive will be located in the build directory and named `converter.phar`.\n\n### 2. Manually\n\nTo manually rebuild the Phar archive, run the following commands:\n\n```\ncd source\ncomposer install\nphp create-phar.php\n```\n\nWhen completed, the Phar archive will be located in the root of the repository, and named `converter.phar`.\n\n## Usage Instructions\n\n### Creating an AsciiDoc navigation menu\n\nTo creating an AsciiDoc navigation menu, you have to pass a list of AsciiDoc files that you want to create an AsciiDoc navigation menu for to the `navigation:build-from-files` command.\n\nThe following example shows how to find all AsciiDoc files, and to pipe that file list to the`navigation:build-from-files` command.\n\n```console\nfind ./path/to/my/manual/modules/ROOT/pages \\\n\t-type f -name \"*.adoc\" | \\\n\tphp converter.phar navigation:build-from-files\n```\n\n### List Available Commands\n\nTo list the available commands, supported by the Phar archive, just run it without any additional arguments, as in the example command below:\n\n```console\nphp converter.phar\n```\n\nCurrently, this will output the following to the console:\n\n```php\n#!/usr/bin/env php\n\nConsole Tool\n\nUsage:\n  command [options] [arguments]\n\nOptions:\n  -h, --help            Display this help message\n  -q, --quiet           Do not output any message\n  -V, --version         Display this application version\n      --ansi            Force ANSI output\n      --no-ansi         Disable ANSI output\n  -n, --no-interaction  Do not ask any interactive question\n  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug\n\nAvailable commands:\n  help                         Displays help for a command\n  list                         Lists commands\n navigation\n  navigation:build-from-files  Creates a navigation AsciiDoc file from the source files\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsettermjd%2Fsphinx-to-antora-migrator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsettermjd%2Fsphinx-to-antora-migrator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsettermjd%2Fsphinx-to-antora-migrator/lists"}