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

Documentation cleanup #533

Merged
merged 8 commits into from
Jul 18, 2021
Merged

Documentation cleanup #533

merged 8 commits into from
Jul 18, 2021

Conversation

akaszynski
Copy link
Collaborator

This PR cleans up the documentation by:

  • Using internal links for any method or class references
  • Adds external links for various linked projects.
  • Refactor API documentation to make it easier to navigate.
  • Move Query class documentation to the API section.

Also edits the CI with:

  • Adding development doc nightly build step (will be deployed to dev.mapdldocs.pyansys.com after merge).
  • Removing the full API build step for the docbuild. There's no reason to do a full doc-build for each PR, it's sufficient to build nightly and run a docbuild smoketest.

Copy link
Contributor

@jgd10 jgd10 left a comment

Choose a reason for hiding this comment

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

LGTM. I saw a couple of spelling mistakes, which I've already corrected and also made a suggestion about non_interactive, but that might be worth going in a separate issue rather than being a focus of this PR.

@@ -145,10 +144,34 @@ def __init__(self, loglevel='DEBUG', use_vtk=True, log_apdl=False,

self._post = PostProcessing(self)

@property
Copy link
Contributor

Choose a reason for hiding this comment

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

Would this be better as a function? I think it's already a property, so this might be a breaking change, but seeing with for a property looks quite odd to me, maybe it's also the lack of an as thing as well!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I agree that it's a bit odd, I was trying for simplicity here:

with mapdl.non_interactive:
   mapdl.prep7()
   ...

vs a more standard approach:

with mapdl.non_interactive() as ni:
    ni.prep7()
    ...

However, the former approach is non-standard and I'll agree that it has side effects (since it's effectively changing the state of the mapdl object). Let's consider changing this in a future PR.

@akaszynski akaszynski merged commit 708d303 into main Jul 18, 2021
@akaszynski akaszynski deleted the doc/fix_api branch July 18, 2021 22:18
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