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

Set up doc for Ansys Sphinx theme like PyAnsys libraries #103

Merged
merged 7 commits into from
Aug 22, 2022

Conversation

PipKat
Copy link
Member

@PipKat PipKat commented Aug 19, 2022

Instead of the odd sections in the nav bar, I redid this to use Getting Started and User Guide.
Do we want to implement Vale?

Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

Some minor changes (especially regarding folder naming conventions). But apart from that all good. Thanks @PipKat!

Regarding Vale, I do agree we should implement it. Let me open a different PR for this 😃

doc/source/User_guide/options.rst Outdated Show resolved Hide resolved
doc/source/index.rst Outdated Show resolved Hide resolved
doc/source/index.rst Outdated Show resolved Hide resolved
doc/source/User_guide/css.rst Outdated Show resolved Hide resolved
doc/source/User_guide/index.rst Outdated Show resolved Hide resolved
doc/source/User_guide/options.rst Outdated Show resolved Hide resolved
doc/source/User_guide/options.rst Outdated Show resolved Hide resolved
doc/source/User_guide/pdf.rst Outdated Show resolved Hide resolved
doc/source/User_guide/404_page.rst Outdated Show resolved Hide resolved
@RobPasMue RobPasMue mentioned this pull request Aug 22, 2022
@RobPasMue
Copy link
Member

Hi @PipKat! I implemented vale in the ansys-sphinx-theme repo. It should be available for your use already. I have also updated your branch so that it has vale in it.

Please run git pull when you get back to working on this PR so that you have the latest changes =)

PipKat and others added 4 commits August 22, 2022 10:02
Incorporate Roberto's feedback

Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
Incorporate missed change.

Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
Google style guide:
When referring to the abstract data type, use lowercase. (In the unlikely event that you refer to Boolean mathematics or Boolean logic, use uppercase.)
@RobPasMue RobPasMue merged commit 4f913dd into main Aug 22, 2022
@RobPasMue RobPasMue deleted the doc/minor_theme_doc_edits branch August 22, 2022 14:41
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