Skip to content

Fix/issue 659 #675

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
merged 7 commits into from
Dec 28, 2021
Merged

Fix/issue 659 #675

merged 7 commits into from
Dec 28, 2021

Conversation

MaxJPRey
Copy link
Collaborator

Fix issue #659 .
Logo is now provided through the pyansys_sphinx_theme.
In addition, the templates are no longer required.

Notify that PyAEDT is part of the larger PyANSYS effort in the README.rst file.

@MaxJPRey MaxJPRey marked this pull request as draft December 24, 2021 16:00
@MaxJPRey MaxJPRey linked an issue Dec 24, 2021 that may be closed by this pull request
@MaxJPRey MaxJPRey marked this pull request as ready for review December 24, 2021 16:19
@@ -20,7 +22,7 @@

sys.path.append(os.path.join(root_path))
project = "PyAEDT"
copyright = "(c) 2021 ANSYS, Inc. All rights reserved"
copyright = f"(c) {datetime.datetime.now().year} ANSYS, Inc. All rights reserved"
author = "Ansys Inc."

# Check for the local config file, otherwise use default desktop configuration
Copy link
Collaborator Author

@MaxJPRey MaxJPRey Dec 24, 2021

Choose a reason for hiding this comment

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

@akaszynski In this file, few lines below, to get the semantic version, we are doing:

with open(os.path.join(root_path, "pyaedt", "version.txt"), "r") as f:
    release = version = f.readline()

Do you think that we should expose the version in the _version.py with an attribute like this __version__ and then do in the conf.py file:
release = version = __version__

If yes, I will open an issue and commit this change in a separate pull request.

Copy link
Contributor

Choose a reason for hiding this comment

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

Both approaches work. Since we already need to import pyaedt for the auto documentation to be built, I think it’s easier to:

from pyaedt import __version__

Copy link
Contributor

@akaszynski akaszynski left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for fixing this. Please validate that the docs at dev.docs.pyaedt.com are valid once this is merged.

@akaszynski akaszynski merged commit e7dd6a0 into main Dec 28, 2021
@akaszynski akaszynski deleted the fix/issue_659 branch December 28, 2021 04:27
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.

Update to latest pyansys-sphinx-theme
2 participants