ENH: include root index.html in --html output
#104
Conversation
pdoc/cli.py
Outdated
| @@ -487,6 +487,25 @@ def docfilter(obj, _filters=args.filter.strip().split(',')): | |||
| # Two blank lines between two modules' texts | |||
| sys.stdout.write(os.linesep * (1 + 2 * int(module != modules[-1]))) | |||
|
|
|||
| # Add the root index.html at the top level | |||
| if args.html: | |||
There was a problem hiding this comment.
This is adapted from WebDoc.do_GET on "/". That one doesn't use the pydoc.Module class for the root index. It uses args.modules and imports the modules to get the name and docstring.
When I tried doing it in the same way here, there were some inconsistencies with the rest of the --html behavior that was causing some weird breakages and test errors. Otherwise, I would have pulled the logic out into a helper function.
| modules=module_tuples, | ||
| **template_config) | ||
| index_file = path.join(args.output_dir, 'index.html') | ||
| try: |
There was a problem hiding this comment.
And this logic is adapted from write_files. I couldn't use it directly, since it expects a pdoc.Module as input, so I just copy-pasted. I can go back and refactor that to be more DRY if you prefer.
| @@ -487,6 +492,25 @@ def docfilter(obj, _filters=args.filter.strip().split(',')): | |||
| # Two blank lines between two modules' texts | |||
| sys.stdout.write(os.linesep * (1 + 2 * int(module != modules[-1]))) | |||
|
|
|||
| if args.html and args.html_index: | |||
There was a problem hiding this comment.
I'll name the arg whatever you want, but this is the general idea.
|
To my point about breaking automation: The CI build was failing for "Deploy" with my initial PR, but it's passing now that I've put the feature behind a flag. |
|
Let's discuss this back in #101. |
Implements #101 .
It adds the root
index.htmlfrom the--httpmode to the static--htmloutput.To avoid breaking people's automations, I've put this feature behind a flag (
--html-index) and left the default behavior alone.I also added the breadcrumbs to the module pages when
--html-indexis active.You can use as much or as little of this as you want. I did this in several small commits so you can see all the options side-by-side.
What's left