{"id":28255164,"url":"https://github.com/pandas-dev/github-doc-previewer","last_synced_at":"2026-05-10T16:31:47.874Z","repository":{"id":219220322,"uuid":"748487521","full_name":"pandas-dev/github-doc-previewer","owner":"pandas-dev","description":"Service to preview documentation from GitHub artifacts","archived":false,"fork":false,"pushed_at":"2024-02-16T14:27:28.000Z","size":101,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-18T13:46:15.262Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","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/pandas-dev.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},"funding":{"custom":"https://pandas.pydata.org/donate.html","github":["numfocus"],"tidelift":"pypi/pandas"}},"created_at":"2024-01-26T04:26:35.000Z","updated_at":"2024-01-26T04:27:27.000Z","dependencies_parsed_at":"2024-01-26T05:38:21.051Z","dependency_job_id":"121c0987-4746-4629-b334-7b89f1dbe3e1","html_url":"https://github.com/pandas-dev/github-doc-previewer","commit_stats":{"total_commits":35,"total_committers":1,"mean_commits":35.0,"dds":0.0,"last_synced_commit":"7a1ea7e96d1a24578ec35eedd4256a7d80c3fef8"},"previous_names":["pandas-dev/github-doc-previewer"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/pandas-dev/github-doc-previewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pandas-dev%2Fgithub-doc-previewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pandas-dev%2Fgithub-doc-previewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pandas-dev%2Fgithub-doc-previewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pandas-dev%2Fgithub-doc-previewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pandas-dev","download_url":"https://codeload.github.com/pandas-dev/github-doc-previewer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pandas-dev%2Fgithub-doc-previewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32863389,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-10T13:40:02.631Z","status":"ssl_error","status_checked_at":"2026-05-10T13:40:02.145Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":[],"created_at":"2025-05-19T21:12:53.442Z","updated_at":"2026-05-10T16:31:47.852Z","avatar_url":"https://github.com/pandas-dev.png","language":"Rust","funding_links":["https://pandas.pydata.org/donate.html","https://github.com/sponsors/numfocus","https://tidelift.com/funding/github/pypi/pandas"],"categories":[],"sub_categories":[],"readme":"# GitHub Documentation Previewer\n\nWeb service that publishes a preview of a GitHub project documentation.\n\nThe documentation itself has to be built during the project continuous\nintegration and published as a GitHub actions artifact.\n\n## Client installation\n\nTo be able to use this service in your project, you need to have a CI\njob that looks like this:\n\n```yaml\non: [ push, pull_request ]\n\njobs:\n  doc:\n    name: Build Documentation\n    runs-on: ubuntu-latest\n    steps:\n      # Instead of this step you may have a step to check out the repository,\n      # another to call `sphinx-build`, or anything that generates a directory\n      # with the html version of your website or documentation\n      - run: mkdir docs_dir \u0026\u0026 echo \"Preview is working!\" \u003e docs_dir/index.html\n\n      - uses: actions/upload-artifact@v4\n        with:\n          name: docs_artifact\n          path: docs_dir\n```\n\nThen, you can add one action in your CI to for example publish the website or\ndocumentation of a pull request when a user writes a comment with the content\n`/preview`:\n\n```yaml\non:\n  issue_comment:\n    types: created\n\njobs:\n  previewer:\n    runs-on: ubuntu-latest\n    permissions:\n      pull-requests: write\n    if: github.event.issue.pull_request \u0026\u0026 github.event.comment.body == '/preview'\n    steps:\n      - uses: pandas-dev/github-doc-previewer@master\n        with:\n          # The server specified here has to explicitly allow your GitHub organization\n          previewer-server: \"https://pandas.pydata.org\"\n\n          # Note that this has to match with the name of the job where the\n          # `upload-artifact` action is called\n          artifact-job: \"Build Documentation\"\n```\n\n## Server Installation\n\nCurrently only packages for Debian are provided. The package can be installed\nusing the next command:\n\n```\ncurl -sLO https://github.com/pandas-dev/github-doc-previewer/releases/download/v0.3.1/doc-previewer_0.3.1-1_amd64.deb \\\n    \u0026\u0026 sudo dpkg -i doc-previewer_0.3.1-1_amd64.deb \\\n    \u0026\u0026 rm doc-previewer_0.3.1-1_amd64.deb\n```\n\nTo start the service:\n\n```\nsudo systemctl enable doc-previewer.service\nsudo systemctl start doc-previewer.service\n```\n\n### Configuration\n\nA sample configuration file is next:\n\n```toml\npreviews_path = \"/var/doc-previewer\"\nretention_days = 14\nmax_artifact_size = 524288000\n\n[server]\naddress = \"0.0.0.0\"\nport = 8000\nurl = \"https://doc-previewer.pydata.org/\"\n\n[github]\nentrypoint = \"https://api.github.com/repos/\"\ntoken = \"xxxxx\"\nallowed_owners = [ \"pandas-dev\", \"pydata\" ]\n\n[log]\nlevel = \"info\"\n```\n\nAll the fields are optional except for the GitHub token, which is required.\n\n### Logging\n\nWhen a problem exists, the service will in general report it to the client.\nChecking the logs of the `github-doc-previewer` action run that failed may\nprovide information on the cause of the problem. Errors will also be logged\nin the server, and can be checked using the standard journal logs:\n\n```bash\njournalctl -u doc-previewer.service\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpandas-dev%2Fgithub-doc-previewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpandas-dev%2Fgithub-doc-previewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpandas-dev%2Fgithub-doc-previewer/lists"}