docs: add quartodoc website for documentation

[tdstein]

Adds a documentation site using Quartodoc. Various changes are introduced to the docstrings in order to accommodate Quartodoc nuances.

Resolves #196

Do the following to preview.

cd docs
make
make preview

Do the following to build from root, assuming deps and dev or build are ran prior.

make docs

Now that a base is established, I will do smaller PRs for incremental changes.

[github-actions]

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
1018	978	96%	80%	🟢

New Files

No new covered files...

Modified Files

File	Coverage	Status
src/posit/init.py	100%	🟢
src/posit/connect/bundles.py	100%	🟢
src/posit/connect/client.py	100%	🟢
src/posit/connect/content.py	98%	🟢
src/posit/connect/metrics/init.py	100%	🟢
src/posit/connect/metrics/usage.py	100%	🟢
src/posit/connect/permissions.py	100%	🟢
src/posit/connect/tasks.py	100%	🟢
src/posit/connect/users.py	100%	🟢
TOTAL	100%	🟢

updated for commit: 50b795f by action🐍

[tdstein]

The docs site is far from perfect, but this at least gets things moving.

[nealrichardson]

Thanks for taking this on. There's lots to improve here, but we can tackle that as we go. Might be good to bring in Greg or others that worked on Shiny's docs recently, their site looks nice and I notice they have some custom code to handle some formatting.

The one thing I'd like to see if we could solve from the beginning is the URL structure. Instead of /reference/connect.bundles.html etc., could we make that be /reference/connect/bundles.html, i.e. have the connect submodule be a subdirectory?

[tdstein]

The one thing I'd like to see if we could solve from the beginning is the URL structure. Instead of /reference/connect.bundles.html etc., could we make that be /reference/connect/bundles.html, i.e. have the connect submodule be a subdirectory?

Not that I have found. These URLs are configured by Quartodoc, and I do not see a way to force them to this style. @machow - do you know if this is possible?

[wydsith]

We should be using the Posit Theme instead of the default cosmo - https://github.com/posit-dev/product-doc-theme?tab=readme-ov-file#product-doc-theme

[tdstein]

We should be using the Posit Theme instead of the default cosmo - https://github.com/posit-dev/product-doc-theme?tab=readme-ov-file#product-doc-theme

Thanks! I'll add that.

[wydsith]

Thanks for getting the theme added! I think it still needs some tweaking - there's missing Footer info that has content required by Marketing/Legal. Ashley or I can poke at it if you have trouble, just let me know!

[wydsith]

Suggested change

	# Install Posit's SDK
	# Install the Posit SDK

[tdstein]

Thanks for getting the theme added! I think it still needs some tweaking - there's missing Footer info that has content required by Marketing/Legal. Ashley or I can poke at it if you have trouble, just let me know!

Thanks for the review! I ran into issues installing the theme as instructed within the Makefile. As you can see in the _quarto.yaml, I ended up directly importing the assets to get around this. I'll look into adding the footer.

[tdstein]

Will address subsequent issues in follow up.