module pycode.doc_helper
¶
Short summary¶
module pyquickhelper.pycode.doc_helper
Helpers to improve documentation.
Functions¶
function |
truncated documentation |
---|---|
Finds all links following RST format in a documentation. |
|
Checks that all urls are valid. |
|
Looks for all files in a folder and return all invalid urls. |
Documentation¶
Helpers to improve documentation.
- pyquickhelper.pycode.doc_helper.find_link(text)[source]¶
Finds all links following RST format in a documentation.
- Parameters:
text – text
- Returns:
all urls
- pyquickhelper.pycode.doc_helper.validate_urls_in_folder(folder, ext='py,rst,ipynb', neg_pattern='.*__pycache__.*', recursive=True, verbose=False)[source]¶
Looks for all files in a folder and return all invalid urls.
- Parameters:
folder – folder to look into
ext – files extension to look into
neg_pattern – exclude files following that pattern
recursive – look into sub folders
verbose – use :epkg:`tqdm` to display a progress bar
- Returns:
enumerator on issues