Docs fixes & improvements #103
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #103 +/- ##
=======================================
Coverage 90.74% 90.74%
=======================================
Files 48 48
Lines 4389 4389
Branches 271 271
=======================================
Hits 3983 3983
Misses 317 317
Partials 89 89
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
sarina
force-pushed
the
sarina/docs-improvements
branch
2 times, most recently
from
de0203d to
05b49fa
Compare
sarina
force-pushed
the
sarina/docs-improvements
branch
from
05b49fa to
0f14c9e
Compare
…cally - Add Makefile target + dependency on sphinx-autobuild - Add gitignore for apidocs generated documentation - Update requirements to install package locally for apidoc generation
sarina
force-pushed
the
sarina/docs-improvements
branch
from
15b28a1 to
020d0cf
Compare
| .. warning:: | ||
| Location regex is a powerful but technical feature. Test your regex patterns carefully to ensure they match the intended units. | ||
|
|
||
| Customizing Prompts |
There was a problem hiding this comment.
I broke this out into its own how-to article, and linked it in the .. seemore:: section at the end of this article
|
@felipemontoya I plan more docs improvements but this is getting kind of big so want to merge this one first. |
sarina
force-pushed
the
sarina/docs-improvements
branch
from
e227a4b to
bb78cbe
Compare
|
@MaferMazu can you please take a look and review this PR |
MaferMazu
left a comment
MaferMazu
left a comment
There was a problem hiding this comment.
Thanks for this contribution, it worked as expected.
I reviewed the links and reference and they work. I also follow the customizing_prompts how-to and works, and reviewed the framework_concepts, which are aligning with the current documentation and functionality.
Thanks, I only have a minor comment. The rest looks good to me. ✨
| twine # Validates README.rst for usage on PyPI | ||
| build # Needed to build the wheel for twine check | ||
| Sphinx # Documentation builder | ||
| sphinx-autobuild # Needed to autobuild docs locally No newline at end of file |
There was a problem hiding this comment.
We should add a newline at the end.
Reference: https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206
3 participants
Get make html & make serve_docs running locally without errors
Various docs improvements for readability