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

Maintain edit this button style and version switcher #143

Merged
merged 5 commits into from
Nov 7, 2022

Conversation

Revathyvenugopal162
Copy link
Contributor

fix partially #141.

@Revathyvenugopal162 Revathyvenugopal162 self-assigned this Nov 3, 2022
@Revathyvenugopal162 Revathyvenugopal162 added the maintenance Generic maintenance related label Nov 3, 2022
@github-actions github-actions bot added dependencies Related with project dependencies documentation labels Nov 3, 2022
This is unexpected. The page you are requesting does not exist.

If this page should exist, please contact `{{ theme_contact_mail }} <mailto:{{ theme_contact_mail }}`_.
If this page should exist, please contact `{{ theme_contact_mail }} <{{ theme_contact_mail }}>`_.
Copy link
Member

Choose a reason for hiding this comment

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

Is there any reason behind removing the mailto directive and the :orphan: one, @Revathyvenugopal162?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes,

  1. The 404-page html is not rendered as expected. you can check it https://sphinxdocs.ansys.com/404.html. i am expecting, the toc tree, logo and nav bar on the page, so i will open another PR for customized 404 page in which can redirect for edit this page for API/ examples.
  2. We are not putting the 404.rst page in our doc, rather we are importing from ansys-sphinx-theme, later rendered to an html, so if we are giving/not giving orphan, doesnt matter, since we are giving the directive orphan to silence the spurious document isn't included in any toctree warning. and it is directly rendering as 404 html, not 404.rst

Copy link
Member

Choose a reason for hiding this comment

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

Thanks a lot for the detailed explanation on the 404 page, @Revathyvenugopal162.

What about the mailto directive? Did it introduce any issues?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it is also not rendering as expected, not giving the href for the link.

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.

LGTM

doc/source/conf.py Outdated Show resolved Hide resolved
Copy link
Contributor

@MaxJPRey MaxJPRey left a comment

Choose a reason for hiding this comment

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

LGTM.

Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
@RobPasMue RobPasMue enabled auto-merge (squash) November 7, 2022 10:37
@RobPasMue
Copy link
Member

RobPasMue commented Nov 7, 2022

Merging since all reviewers gave green-light

@RobPasMue RobPasMue merged commit 38dcd06 into main Nov 7, 2022
@RobPasMue RobPasMue deleted the maint/edit-this-button-style branch November 7, 2022 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Related with project dependencies maintenance Generic maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants