Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Service to preview documentation from GitHub artifacts

License

NotificationsYou must be signed in to change notification settings

pandas-dev/github-doc-previewer

Web service that publishes a preview of a GitHub project documentation.

The documentation itself has to be built during the project continuousintegration and published as a GitHub actions artifact.

Client installation

To be able to use this service in your project, you need to have a CIjob that looks like this:

on:[ push, pull_request ]jobs:doc:name:Build Documentationruns-on:ubuntu-lateststeps:# Instead of this step you may have a step to check out the repository,# another to call `sphinx-build`, or anything that generates a directory# with the html version of your website or documentation      -run:mkdir docs_dir && echo "Preview is working!" > docs_dir/index.html      -uses:actions/upload-artifact@v4with:name:docs_artifactpath:docs_dir

Then, you can add one action in your CI to for example publish the website ordocumentation of a pull request when a user writes a comment with the content/preview:

on:issue_comment:types:createdjobs:previewer:runs-on:ubuntu-latestpermissions:pull-requests:writeif:github.event.issue.pull_request && github.event.comment.body == '/preview'steps:      -uses:pandas-dev/github-doc-previewer@masterwith:# The server specified here has to explicitly allow your GitHub organizationpreviewer-server:"https://pandas.pydata.org"# Note that this has to match with the name of the job where the# `upload-artifact` action is calledartifact-job:"Build Documentation"

Server Installation

Currently only packages for Debian are provided. The package can be installedusing the next command:

curl -sLO https://github.com/pandas-dev/github-doc-previewer/releases/download/v0.3.1/doc-previewer_0.3.1-1_amd64.deb \    && sudo dpkg -i doc-previewer_0.3.1-1_amd64.deb \    && rm doc-previewer_0.3.1-1_amd64.deb

To start the service:

sudo systemctl enable doc-previewer.servicesudo systemctl start doc-previewer.service

Configuration

A sample configuration file is next:

previews_path ="/var/doc-previewer"retention_days =14max_artifact_size =524288000[server]address ="0.0.0.0"port =8000url ="https://doc-previewer.pydata.org/"[github]entrypoint ="https://api.github.com/repos/"token ="xxxxx"allowed_owners = ["pandas-dev","pydata" ][log]level ="info"

All the fields are optional except for the GitHub token, which is required.

Logging

When a problem exists, the service will in general report it to the client.Checking the logs of thegithub-doc-previewer action run that failed mayprovide information on the cause of the problem. Errors will also be loggedin the server, and can be checked using the standard journal logs:

journalctl -u doc-previewer.service

About

Service to preview documentation from GitHub artifacts

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

[8]ページ先頭
©2009-2025 Movatter.jp