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

Feat: change the api layout to autoapi layout. #3708

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Revathyvenugopal162
Copy link
Contributor

No description provided.

@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@github-actions github-actions bot added documentation enhancement New features or code improvements labels Oct 5, 2023
@codecov
Copy link

codecov bot commented Oct 5, 2023

Codecov Report

Merging #3708 (2580cac) into main (68d1c76) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3708      +/-   ##
==========================================
- Coverage   81.01%   81.01%   -0.01%     
==========================================
  Files         179      179              
  Lines       61729    61729              
==========================================
- Hits        50010    50009       -1     
- Misses      11719    11720       +1     

def prepare_jinja_env(jinja_env) -> None:
"""
Customize the jinja env.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Customize the jinja env.
Customize the Jinja environment.

Notes
-----
See https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
See https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment
For more information on the ``environment`` class, see `High Level API
<https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment> in the
Jinja documentation."

@Samuelopez-ansys
Copy link
Member

@Revathyvenugopal162 What is the status of this PR?

@Revathyvenugopal162
Copy link
Contributor Author

I added my commits and @SMoraisAnsys is expected to take over this, @SMoraisAnsys are we going to change this to autoapi?

@MaxJPRey
Copy link
Collaborator

I added my commits and @SMoraisAnsys is expected to take over this, @SMoraisAnsys are we going to change this to autoapi?

@Revathyvenugopal162 yes that would be the plan.

@SMoraisAnsys
Copy link
Collaborator

SMoraisAnsys commented Nov 27, 2023

I should start to work on this after the EDB API is extracted from pyaedt. This is still a work in progress. Btw, I think that Jorge developments (readthedocs/sphinx-autoapi#399) were a prerequisite for integration into pyaedt. However, they are not yet merged.

@Samuelopez-ansys We can close this PR ftm, I can open it back later. Just don't remove the branch :)

@Samuelopez-ansys
Copy link
Member

@SMoraisAnsys We can leave it opened, I just wanted to know the status. It is a draft so no problem at all. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants