Repository navigation
docs: publish docs to gihub.io - #16
Merged
Merged
Conversation
PatKamin
marked this pull request as ready for review
October 14, 2026 08:34
PatKamin
force-pushed
the
publish-docs
branch
from
October 14, 2026 08:34
90cbc2a to
6de7e0d
Compare
PatKamin
commented
Oct 14, 2026
PatKamin
force-pushed
the
publish-docs
branch
2 times, most recently
from
October 14, 2026 12:09
1963071 to
d16ce1a
Compare
PatKamin
force-pushed
the
publish-docs
branch
from
October 14, 2026 12:59
61844d3 to
045d896
Compare
PatKamin
force-pushed
the
publish-docs
branch
from
October 15, 2026 07:44
7e8d28d to
edfbcde
Compare
properdocs doesn't recognise links outside docs/ dir. Rephrased as README.md already references install.md. Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
with no warnings Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
properdocs takes links as relative to docs/ dir, whereas links used on GitHub are resolved as relative to the root dir of the project. Clean up links handling so it's easier to maintain. Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
No need for these renames. Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
It has the same name as the old AITune-derived one, but completely new contents. Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
To avoid random CI failures of documentation builds, don't check any external links. Also, do not link to files outside the docs/ dir. Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
Move ruff install to [doc] extra, ruff is used by mkdocstrings_handlers for formatting documentation. Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
PatKamin
force-pushed
the
publish-docs
branch
from
October 15, 2026 07:59
edfbcde to
eb266fd
Compare
lukaszstolarczuk
approved these changes
Oct 15, 2026
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.
fix(docs): properdocs doesn't recognise links outside docs/ dir. Rephrased as README.md already references install.md.
ci(docs): deploy docs to gh-pages