First is doc building currently we use `nox` to build our do

Question

First is doc building currently we use `nox` to build our docs a single docset for the whole monorepo which basically implies starting a new virtualenv installing sphinx and a couple of things and running `sphinx build` This command needs to be able to load the libraries as we have all sorts of autodocs features I have been thinking on how to achieve that with pants and I guess I should create a new target that would be `sphinx docs` and it would have all the libraries as dependencies However it seems strange that this has never come up I have searched slack to no avail so I thought I d ask first

adorable-engine-71736 · Answer

hi im new to pants so not sure to much of existing ecosytem i am however looking to build out some docs using sphinx pydoc etc i just landed a beta readme creater in our repo and im thinking to do something similar for building out sphinx docs

happy-kitchen-89482 · Answer

Hi < adorable engine 71736> would love to hear how you designed your readme implementation

happy-kitchen-89482 · Answer

Re sphinx so you re using it to generate docs out of docstrings in py files Or are there also other inputs

happy-kitchen-89482 · Answer

that was a question for either of you

adorable-engine-71736 · Answer

i was thinking to get some kind of pydoc from the doc strings i was thinking other info but at least partly auto generated eg with package data etc the readme implementation is here <https github com envoyproxy pytooling pull 96 files> ive used it as a bit of crash course in learning pants so view it as beta 8

astonishing-london-2419 · Answer

this is correct

astonishing-london-2419 · Answer

I use `sphinx apidoc`

astonishing-london-2419 · Answer

and then `automodule` and the like

astonishing-london-2419 · Answer

so it s usually easy to build

astonishing-london-2419 · Answer

but you need all the libraries to be available

happy-kitchen-89482 · Answer

The reason I ask is that maybe you don t need a special target type and instead you run a new `docgen` goal on the existing python library targets

happy-kitchen-89482 · Answer

So like ` pants docgen path to targets ` or whatever

happy-kitchen-89482 · Answer

This could work just like how linters work

happy-kitchen-89482 · Answer

They don t require a special target type

happy-kitchen-89482 · Answer

So I m trying to figure out what the perceived need for a `sphinx docs` target is

adorable-engine-71736 · Answer

i have a `sphinx runner` that i currently use in bazel for the main envoy docs

adorable-engine-71736 · Answer

basically bazel collects up configured tarballs from different parts of the repo and feeds the tarball s to the runner to turn into html in this case

adorable-engine-71736 · Answer

this does a lot of bazel stuff eg turning protobuf gt api

adorable-engine-71736 · Answer

for the tooling site im working on i mostly want a way to ~declaratively minimally express the structure of the repo gt collection of pydoc general documentation

adorable-engine-71736 · Answer

i didnt think much beyond that

astonishing-london-2419 · Answer

yes a new goal instead could make sense The reason I thought of new targets is because it s a single unified set of docs and therefore they are all generated together so I don t see how that could work running a new goal on each library

adorable-engine-71736 · Answer

im gonna look a bit further at docgen its not installed by default and google doesnt turn up much in the way of useful results

astonishing-london-2419 · Answer

it used to be in pants v1 I think but I don t see it in v2

happy-kitchen-89482 · Answer

Yeah it doesn t exist I was suggesting creating it slightly smiling face

happy-kitchen-89482 · Answer

And I guess borrowing the name from v1 I didn t even remember that it existed there

adorable-engine-71736 · Answer

so im doing some further work on my readme goal atm and my thought was that once that was ~complete i would hack something out of it to generate rst files and feed to sphinx

adorable-engine-71736 · Answer

im just getting used to pants dev so it will take me some time but if there is anything useful im more than happy to share or to contribute to a common effort

adorable-engine-71736 · Answer

i think being able to generate validate docs and readme are v useful features

happy-kitchen-89482 · Answer

very useful and we d love to have your contributions We re happy to help with the plugin API etc