You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
This PR cleans up the existing PyAnsys developer's doc so that it follows our style guidelines. Note that I have the Vale error again indicating that there are too many results (annotations) in the diff.
Changes made in this PR:
Set up code block examples using tabs as in others other parts of the dev guide. (I'm not sure if the "Define a caption and name for referencing a code block" section is showing correctly what would render in the documentation.)
Replaced occurrences of "via" as the Google style guide and others recommend avoiding this word.
Removed glossary as its inclusion (and correctness) was questioned long ago.
Add content on the naming format required for Python folders and files (underscore must be used as space delimiter) and recommended for RST folder and files (hyphen should be used for search optimization of the HTML documentation).
Add information on how to comment out lines if you are not using the sphinx.ext.todo extension but why adding and using this native Sphinx extension is recommended.
Document how to use the git clean -fdx . command to remove untracked files and directories.
Add info about how new user overall index.rst files (doc landing pages) use a grid of cards to present the organization of the documentation in a visual manner.
@RobPasMue@dipinknair Hi, Roberto. Dipin and I met on Friday afternoon to look at the Vale issues. We both agreed that it would be best for you to review and force merge this PR and then create and assign an issue for him to investigate. We don't want to ignore the Google HEADING rule to use sentence case. However, it's through errors for titles that are using sentence case. (The only capital letter in the title is the one on the initial word.) It's also throwing errors when proper nouns are used in titles, but those proper nouns should be fine because the exist in the project's accept.txt file. It will be easier to Dipin to investigate after this very large PR is merged. I have finished reviewing content in these dev guide sections: "Getting started," "How-to," and "Style." I can finish the last two remaining sections after Dipin's investigation. (Plus, I have some Dev portal and Ansys Store work to do early next week.)
* Clean up of files to follow doc style guidelines
* Clean up of more files to follow doc style guidelines
* Fix broken link
* More cleanup and some content additions
* More cleanup on Friday
* Run pre-commit and Vale; fix errors.
* Fix broken link
* Update doc/source/content-writing/content-how-tos/create-PR.rst
---------
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
documentationImprovements or additions to documentation
3 participants
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.
github-actions
bot
added
the
documentation
This PR cleans up the existing PyAnsys developer's doc so that it follows our style guidelines. Note that I have the Vale error again indicating that there are too many results (annotations) in the diff.
Changes made in this PR:
sphinx.ext.todoextension but why adding and using this native Sphinx extension is recommended.git clean -fdx .command to remove untracked files and directories.index.rstfiles (doc landing pages) use a grid of cards to present the organization of the documentation in a visual manner.