Switch to pydata-theme and split docs

[coretl]

There are now developer and user guides. The version switcher is native to the theme so added a script to generate it.

For comparison:

• Old: https://diamondlightsource.github.io/python3-pip-skeleton/main/index.html
• New: https://diamondlightsource.github.io/python3-pip-skeleton/pydata-docs/index.html

[codecov]

Codecov Report

Merging #56 (48951d6) into main (10e2396) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main       #56   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           16        16           
=========================================
  Hits            16        16           

Impacted Files	Coverage Δ
src/python3_pip_skeleton/__main__.py	100.00% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[coretl]

Just realized we need a corresponding change to the cli module before this can be merged, I'll look at that next week

[gilesknap]

I've tried to merge this into a project but something is broken in skeleton land. I don't believe it is this PR at fault but may be to do with my squashing of the main history.

In the above I am working in the 'containers' branch and I have just fully re-adopted skeleton successfully.

I have then done:

git branch -b docs-merge
git pull git@github.com:DiamondLightSource/python3-pip-skeleton.git pydata-docs

But it looks like instead of getting a merge I'm getting a rebase of all of my project's commits on top of the 'Make tox faster' commit.

Did I break it? - If you look in the history od skeleton main I squashed it down to a single commit after the initial commit and made that single commit the origin for skeleton adoption.

The new origin commit in skeleton is de6d5f1
The project with this issue is git@github.com:gilesknap/mciwb.git

[gilesknap]

Trying to pull main from skeleton immediately after adopting skeleton gets this.

git pull git@github.com:DiamondLightSource/python3-pip-skeleton.git main

results in:

This is after resolving the initial rebase merge conflict with mciwb's initial commit. But now it is in a series of rebase conflicts.

EDIT: moved discussion of this to #57

[gilesknap]

@coretl why is CONTRIBUTING in .github?

[gilesknap]

NOTE: if you use pull to merge in these documentation changes you will be required to manually replace python3-pip-skeleton with your project name. So re-adopt is good (this is only an issue for those that have already adopted skeleton - but its worth noting that re-adoption is probably best after any major surgery like this)

[gilesknap]

Here is a successful merge of the new documentation format https://gilesknap.github.io/mciwb/containers/.

It was reasonably smooth. Just needed to move most of docs/xxx to docs/user/xxx

[coretl]

@coretl why is CONTRIBUTING in .github?

So there are less files in the root... I also wanted to encourage people to read the docs rather than skip straight to the contributing guide