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

Update Mkdocs #35

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
shenxianpeng merged 3 commits into master from mkdocs
Mar 8, 2022
Merged

Update Mkdocs #35

shenxianpeng merged 3 commits into master from mkdocs
Mar 8, 2022

Conversation

@shenxianpeng
Copy link
Collaborator

@shenxianpeng shenxianpeng commented Mar 8, 2022

Hi @2bndy5 I did a little change to your awesome contribution, let me know if any comments. Thank you.

  • Remove How to build the docs section from Home (users may not need to know how to build documentation)
  • Changed "C/C++ Linter Action's Docs" to "C/C++ Linter Action", this would look simpler and shorter.

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Mar 8, 2022
Copy link

sonarqubecloud bot commented Mar 8, 2022

Copy link
Collaborator Author

Added mkdocs-deploy.yml, also deploy the documentation to the Github page environment. it seems duplicate with https://cpp-linter-action.readthedocs.io/en/latest/?badge=latest, I can delete it if you don't think it's necessary.

Copy link
Collaborator

2bndy5 commented Mar 8, 2022

Whatever you want to do, I can adjust to that.

Initially, I thought the RTD site will let users pull up previous versions of the docs, but that RTD feature only works if the docs are built with sphinx (not mkdocs).

shenxianpeng reacted with laugh emoji

@shenxianpeng shenxianpeng merged commit 1ab4508 into master Mar 8, 2022
@shenxianpeng shenxianpeng deleted the mkdocs branch March 8, 2022 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@2bndy5 2bndy5 2bndy5 approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /