docs: add GitHub Pages documentation site - #12
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a complete GitHub Pages documentation site for PyVNCServer using MkDocs Material.
Included
web/noVNCGit submodulemainGitHub Pages
After merge, configure Settings → Pages → Build and deployment → Source → GitHub Actions if the repository is not already using Actions as its Pages source.
The expected documentation URL is:
https://xulek.github.io/PyVNCServer/Validation
The branch is documentation-only. The workflow runs
mkdocs build --strictbefore deployment. Local dependency installation could not be executed in the ChatGPT container because that runtime has no PyPI/network access; GitHub-hosted runners will perform the strict build.Note:
mainreceived the noVNC submodule commit after this branch was created. The documentation already reflects that new submodule setup; the branch changes do not overlap the.gitmodules/submodule commit.