sphinx icon indicating copy to clipboard operation
sphinx copied to clipboard

Expand use of path2doc, combine 'compile_xxx' and 'build_xxx' functions and move file validation into builder

Open stephenfin opened this issue 5 years ago • 2 comments

Feature or Bugfix

  • Refactoring

Purpose

We provide a path2doc helper to convert filenames to their equivalent "docnames". However, we do this translation manually in a few places. Stop doing that.

stephenfin avatar Dec 22 '19 19:12 stephenfin

Please choose correct title or separate PR. This contains two different changes. +1 for usage of path2doc with nits. But another one needs more review and design.

Done. As usual, I'm too used to Gerrit and have submitted multiple separate commits (which you can see here) as one PR. I can submit these as separate PRs if I really have to :smile:

stephenfin avatar Dec 27 '19 13:12 stephenfin

Rebased.

A

AA-Turner avatar Sep 24 '22 15:09 AA-Turner

I changed the failure on non-existing documents to warnings so I can merge, personally I sympathise with @stephenfin's logic that these should be hard failures but I think better if that change was a distinct PR (with CHANGES entry) as opposed to this internal refactoring PR.

A

AA-Turner avatar Sep 26 '22 16:09 AA-Turner

Thanks @stephenfin (3 years late!)

A

AA-Turner avatar Sep 26 '22 16:09 AA-Turner

Thanks @stephenfin (3 years late!)

Thank you :smile:

stephenfin avatar Sep 27 '22 19:09 stephenfin

I changed the failure on non-existing documents to warnings so I can merge, personally I sympathise with @stephenfin's logic that these should be hard failures but I think better if that change was a distinct PR (with CHANGES entry) as opposed to this internal refactoring PR.

...and yes, this makes sense. I'll try to get a separate PR up (if you or someone else doesn't beat me to it)

stephenfin avatar Sep 27 '22 19:09 stephenfin