ansys-templates edits to doc #39
Conversation
|
|
||
| .. code:: bash | ||
|
|
||
| python -m pip install --user pipx | ||
|
|
||
| Ensure that `pipx`_ is in your ``PATH`` by running: | ||
| Ensure that `pipx`_ is in your ``PATH`` with: | ||
|
|
||
| .. code:: bash | ||
|
|
||
| python -m pipx ensurepath |
There was a problem hiding this comment.
Kelly had trouble here. She could run python -m pip ensurepath but not use pipx. It could be she missed something though as she is new to process.
There was a problem hiding this comment.
python -m pip ensurepath
Just to make sure, this should be python -m pipx ensurepath (not pip).
There was a problem hiding this comment.
That is what it says--but it didn't work for her. Kelly said she did install pipx as instructed but it didn't work for installing pyansys-templates. She received this error:
Error: File "C:\Users\kfletche\AppData\Roaming\Python\Python37\site-packages\packaging\utils.py", line 34, in canonicalize_name
value = _canonicalize_regex.sub("-", name).lower()
TypeError: expected string or bytes-like object
There was a problem hiding this comment.
This error does not provide enough information... I recommend Kelly to open an issue on this repo pasting the full set of commands and the output she gets. If she is not familiar with this workflow, there is no problem on having a quick virtual meeting to investigating this @PipKat.
doc/source/user_guide/templating.rst
Outdated
| You can easily add new templates to ``ansys-templates``. Before adding a new | ||
| template, it is important that you read the CONTRIBUTING section. | ||
| You can easily add new PyAnsys templates. However, before doing so, it is important that | ||
| you read the CONTRIBUTING section. |
There was a problem hiding this comment.
Is this section yet to be added or will it be to the overall Contributing section in the PyAnsys Developer's Guide. I assume that it will someday have a contributing.rst file of its own that references the Contributing topic in the PyAnsys Developer's Guide. At that point, we should have the link text here be Contributing--not CONTRIBUTING.
There was a problem hiding this comment.
Good catch on this one, @PipKat! I was planning to link this to some contributing section when available in the dev-guide. I guess that for the moment we can link this to https://dev.docs.pyansys.com/guidelines/dev_practices.html#contributing-through-github
There was a problem hiding this comment.
Linked this to ansys/pyansys-dev-guide#64
…ansys-templates into doc/general_doc_edits
Co-authored-by: Dominik Gresch <[email protected]>
Use pipx with literal tagging in heading
Use pip in heading with literal tagging Co-authored-by: Dominik Gresch <[email protected]>
Fix underline that was too short.
Fix another underline that was too short.
Fix bullet with unexpected indent and missing blank line ending list
There was a problem hiding this comment.
Thanks for the deep review @PipKat! I left some comments. Most of those are related with the fact that the repo is named pyansys-templates but the tool provided is named ansys-templates.
Should we make it consistent? I can see how this might be confusing to users. |
I thought about this too... From my point of view, calling it When naming this, I just imposed it to be |
I agree with the reasoning regarding the python library name, but we probably should change this repo name to |
I agree with this, let's rename it to |
|
Done! |
doc/source/user_guide/templating.rst
Outdated
| You can easily add new templates to ``ansys-templates``. Before adding a new | ||
| template, it is important that you read the CONTRIBUTING section. | ||
| You can easily add new PyAnsys templates. However, before doing so, it is important that | ||
| you read the CONTRIBUTING section. |
There was a problem hiding this comment.
Linked this to ansys/pyansys-dev-guide#64
jorgepiloto
changed the title
There was a problem hiding this comment.
Approving this @PipKat, thanks for the deep review.
We agreed on renaming the repository as ansys-templates so it matches the name of the CLI tool provided.
|
This is good to merge @jorgepiloto. |
|
Merging this! Thanks for deep review, @PipKat 🚀 We still need to investigate the installation issue Kelly reported. |
|
@jorgepiloto Kelly did say that she was able to generate her first local doc build for her solution, but was still very much in the learning process. I don't think she's worried about this issue anymore, but I will tell her to reach out to you if she has any problems later. |
Kelly Fletcher tried to use this doc to set up a PyAnsys project for NSV doc and had problems because ansys-templates was noted instead of pyansys-templates. She also couldn't use pipx. I'll add a comment in the file to better explain.