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

Small docs update #817

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Small docs update #817

merged 1 commit into from
Sep 24, 2024

Conversation

tristanlatr
Copy link
Contributor

Simplify documentation examples and emphasis that pydoctor is a standalone api docs generator.

Option --make-html is not necessary since it's enabled by default.

Option --project-base-dir has automatically the default value of the current working directory, so it's useless to specify it explicitely.

…alone api docs generator.

Option --make-html is not necessary since it's enabled by default.

Option --project-base-dir has automatically the default value of the current working directory, so it's useless to specify it explicitely.
Copy link

codecov bot commented Sep 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.03%. Comparing base (5be6898) to head (4fc9b0a).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #817   +/-   ##
=======================================
  Coverage   92.03%   92.03%           
=======================================
  Files          47       47           
  Lines        8465     8465           
  Branches     1868     1868           
=======================================
  Hits         7791     7791           
  Misses        395      395           
  Partials      279      279           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tristanlatr tristanlatr added this to the 2024 cleanup milestone Sep 24, 2024
@tristanlatr tristanlatr merged commit 502d378 into master Sep 24, 2024
40 checks passed
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.

1 participant