Skip to content
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

Setup config files, folder structure & action for rtd docs #5

Merged
merged 4 commits into from
Sep 17, 2024

Conversation

ederjc
Copy link
Member

@ederjc ederjc commented Sep 13, 2024

  • Added required config files & folder structure for rtd
  • Added GitHub action for docs check
  • Added first placeholder content for the docs

docs/conf.py Outdated
suppress_warnings = ['autosectionlabel.*', 'epub.duplicated_toc_entry']

# Setup the exhale extension
# exhale_args = {
Copy link
Member

Choose a reason for hiding this comment

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

We might not need exhale... At least at the beginning. But we can clean up later.

Copy link
Collaborator

@ramya-subramanyam ramya-subramanyam left a comment

Choose a reason for hiding this comment

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

Looks good! Only the Arduino IDE screenshots needs to be changed to psoc ones. We can do it later

@ederjc ederjc merged commit ae48e82 into develop Sep 17, 2024
2 checks passed
@ederjc ederjc deleted the docs/rtd-setup branch September 23, 2024 16:10
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.

3 participants