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

Fix broken examples documention links. #2118

Merged
merged 5 commits into from
Dec 4, 2023

Conversation

Gamenot
Copy link
Collaborator

@Gamenot Gamenot commented Dec 1, 2023

Fixes some broken links in the documentation.

@Gamenot Gamenot changed the title Fix broken examples links. Fix broken examples documention links. Dec 1, 2023
Comment on lines +1 to +8
.. _base_examples:

Base Examples
==============

Several examples are made available to help you get started with SMARTS.


Copy link
Member

Choose a reason for hiding this comment

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

Consider adding instructions to run the examples.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The examples have help integrated or run just on call.

@Adaickalavan
Copy link
Member

Perhaps we should add a link check in our SMARTS/.github/workflows/ci-format.yml::test_docs .

@Gamenot
Copy link
Collaborator Author

Gamenot commented Dec 4, 2023

Perhaps we should add a link check in our SMARTS/.github/workflows/ci-format.yml::test_docs .

It looks like we can add -b linkcheck to check for dead links. I am going to do that as a separate PR.

@Gamenot Gamenot mentioned this pull request Dec 4, 2023
@Gamenot Gamenot merged commit af19ac5 into master Dec 4, 2023
26 checks passed
@Gamenot Gamenot deleted the tucker/fix-examples_documentation branch December 4, 2023 19:34
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