()
| 299 | |
| 300 | |
| 301 | def main(): |
| 302 | cmds = [method for method in dir(DocBuilder) if not method.startswith("_")] |
| 303 | |
| 304 | joined = ",".join(cmds) |
| 305 | argparser = argparse.ArgumentParser( |
| 306 | description="pandas documentation builder", epilog=f"Commands: {joined}" |
| 307 | ) |
| 308 | |
| 309 | joined = ", ".join(cmds) |
| 310 | argparser.add_argument( |
| 311 | "command", nargs="?", default="html", help=f"command to run: {joined}" |
| 312 | ) |
| 313 | argparser.add_argument( |
| 314 | "--num-jobs", default="auto", help="number of jobs used by sphinx-build" |
| 315 | ) |
| 316 | argparser.add_argument( |
| 317 | "--no-api", default=False, help="omit api and autosummary", action="store_true" |
| 318 | ) |
| 319 | argparser.add_argument( |
| 320 | "--whatsnew", |
| 321 | default=False, |
| 322 | help="only build whatsnew (and api for links)", |
| 323 | action="store_true", |
| 324 | ) |
| 325 | argparser.add_argument( |
| 326 | "--single", |
| 327 | metavar="FILENAME", |
| 328 | type=str, |
| 329 | default=None, |
| 330 | help=( |
| 331 | "filename (relative to the 'source' folder) of section or method name to " |
| 332 | "compile, e.g. 'development/contributing.rst', " |
| 333 | "'pandas.DataFrame.join'" |
| 334 | ), |
| 335 | ) |
| 336 | argparser.add_argument( |
| 337 | "--python-path", type=str, default=os.path.dirname(DOC_PATH), help="path" |
| 338 | ) |
| 339 | argparser.add_argument( |
| 340 | "-v", |
| 341 | action="count", |
| 342 | dest="verbosity", |
| 343 | default=0, |
| 344 | help=( |
| 345 | "increase verbosity (can be repeated), passed to the sphinx build command" |
| 346 | ), |
| 347 | ) |
| 348 | argparser.add_argument( |
| 349 | "--warnings-are-errors", |
| 350 | "-W", |
| 351 | action="store_true", |
| 352 | help="fail if warnings are raised", |
| 353 | ) |
| 354 | argparser.add_argument( |
| 355 | "--no-browser", |
| 356 | help="Don't open browser", |
| 357 | default=False, |
| 358 | action="store_true", |
no test coverage detected