-
Notifications
You must be signed in to change notification settings - Fork 831
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
fix: improve docgen #2043
fix: improve docgen #2043
Conversation
add missing package dependency fix channel resolution
Hey @eisber 👋! We use semantic commit messages to streamline the release process. Examples of commit messages with semantic prefixes:
To test your commit locally, please follow our guild on building from source. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary by GPT-4
The changes made in this commit are as follows:
-
In the
README.md
file, instructions on how to run the tool have been added. This includes changing the directory totools/docgen
, installing the required packages usingpip install -e .
, and running the tool usingpython -m docgen --manifest docgen-manifest.yaml
. -
In the
docgen/__main__.py
file, a minor change has been made to add an extra line after importing a module. -
In the
docgen/channels.py
file, a change has been made to fix an issue with parsing HTML content. The BeautifulSoup constructor now includes thefeatures="html.parser"
argument. -
In the
setup.py
file, a new dependency, "markdown", has been added to the list of required packages.
These changes improve the usability of the tool by providing clear instructions on how to run it and fixing issues related to parsing HTML content.
Suggestions
No suggestions are needed as the changes in this PR seem appropriate and well-implemented.
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Codecov Report
@@ Coverage Diff @@
## master #2043 +/- ##
==========================================
- Coverage 87.05% 83.43% -3.63%
==========================================
Files 306 306
Lines 16063 16063
Branches 852 852
==========================================
- Hits 13984 13402 -582
- Misses 2079 2661 +582 |
* improve readme add missing package dependency fix channel resolution * revert docgen module prefix * remove module_name prefix ---------
add missing package dependency
fix channel resolution
Related Issues/PRs
#xxx
What changes are proposed in this pull request?
Briefly describe the changes included in this Pull Request.
How is this patch tested?
Does this PR change any dependencies?
Does this PR add a new feature? If so, have you added samples on website?
website/docs/documentation
folder.Make sure you choose the correct class
estimators/transformers
and namespace.DocTable
points to correct API link.yarn run start
to make sure the website renders correctly.<!--pytest-codeblocks:cont-->
before each python code blocks to enable auto-tests for python samples.WebsiteSamplesTests
job pass in the pipeline.