Skip to content

Feat/setup #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 16, 2025
Merged

Feat/setup #7

merged 2 commits into from
Jun 16, 2025

Conversation

agustinfrancesa
Copy link
Contributor

First commit, adding code and release process.

agustinfrancesa and others added 2 commits June 16, 2025 09:21
Signed-off-by: Francesa Alfaro, Agustin <agustin.francesa.alfaro@intel.com>
Signed-off-by: Erin Olmon <erin.olmon@intel.com>
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR sets up the initial documentation, configuration, and CI/release workflows for the Intel Sphinx Theme.

  • Adds comprehensive reStructuredText guides for components (cards, blocks, API, admonitions)
  • Defines contributor setup docs, Sphinx build configuration, and static assets (switcher, redirects)
  • Introduces project metadata (README, LICENSE, MANIFEST), changelog placeholder, and GitHub Actions for build checks, security scans, and semantic-release

Reviewed Changes

Copilot reviewed 183 out of 183 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/custom-content/components/cards.rst Example usage of the card component
docs/custom-content/components/blocks.rst Examples for various block directives
docs/custom-content/components/api.rst Autodoc API documentation setup
docs/custom-content/components/admonitions.rst Reference for all admonition types
docs/contributor-guide/setup.rst Contributor getting-started and build instructions
docs/contributor-guide/index.rst Contributor guide table of contents
docs/conf.py Sphinx configuration (extensions, theme options, html_context)
docs/_static/switcher.json Version switcher JSON configuration
docs/_static/redirects/guide-homepage-redirect.html Homepage redirect to user guide
docs/README.md Local build instructions for docs
docs/Makefile Makefile targets for building single/multi-theme HTML outputs
README.md Project installation, configuration, and release process overview
MANIFEST.in Packaging instructions for theme files
LICENSE.md Apache 2.0 license text
CONTRIBUTING.md Updated license link in contributing guidelines
CHANGELOG.md Placeholder for project changelog
.github/workflows/semantic-release.yml Semantic-release workflow for automated versioning and publishing
.github/workflows/check-build.yml Pull-request build-and-wheel creation check
.github/workflows/bandit.yml Bandit security scan workflow
.github/dependabot.yml Dependabot configuration for dependency updates
Comments suppressed due to low confidence (4)

README.md:41

  • This line repeats the previous instruction and incorrectly refers to 'version selector' instead of 'language selector'; update the wording to clarify it's for the language selector.
If you want to add version selector you must define both `current_language` and `languages` properties.

.github/workflows/semantic-release.yml:50

  • [nitpick] Using a sudo symlink in CI can be fragile; consider adjusting library search paths or using a virtual environment without requiring root access.
# symbolic link to fix an error when running a build_command

CHANGELOG.md:1

  • The changelog is currently empty; consider adding initial release notes or a template to guide future entries.
# CHANGELOG

.github/dependabot.yml:9

  • Dependabot is only scanning the repository root, but docs dependencies live in docs/requirements.txt; consider adding a separate entry for the docs directory.
directory: "/" # Location of package manifests


:bdg-primary:`Sample badge`

Example Set 2
Copy link
Preview

Copilot AI Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Example Set 2 and Example Set 3 are identical; consider deduplicating or centralizing the shared snippet to reduce duplication.

Copilot uses AI. Check for mistakes.

"primary_sidebar_end": ["version-switcher"]
}

html_context = {
Copy link
Preview

Copilot AI Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

html_context is first defined at line 43 and then redefined here, which may unintentionally override earlier settings; consolidate into one assignment.

Copilot uses AI. Check for mistakes.

@agustinfrancesa agustinfrancesa merged commit 7551faa into main Jun 16, 2025
3 checks passed
@agustinfrancesa agustinfrancesa deleted the feat/setup branch June 19, 2025 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants