Moving documentation to sphinx+myst

[giovannipizzi]

The content has been moved from the README to the documentation. Note that this is not yet on RTD (so some links might be broken). If the PR is OK, we can merge it and I setup the RTD project?

@chrisjsewell this is my first time with sphinx+myst, so feedback welcome

[codecov[bot]]

Codecov Report

Merging #127 (b8caf44) into develop (7a09ea2) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop     #127   +/-   ##
========================================
  Coverage    99.52%   99.52%           
========================================
  Files            8        8           
  Lines         1675     1675           
========================================
  Hits          1667     1667           
  Misses           8        8           

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 7a09ea2...b8caf44. Read the comment docs.

[chrisjsewell]

Note that this is not yet on RTD (so some links might be broken). If the PR is OK, we can merge it and I setup the RTD project?

Just set up RTD, add a .readthedocs.yaml, and it'll build it for this PR

[giovannipizzi]

https://disk-objectstore.readthedocs.io/en/latest/ seems to exist anymore, did you create it? I cannot find in the aiida RTD account (nor in mine)

[chrisjsewell]

Just set up RTD

did you create it?

[chrisjsewell]

You'll see its in the PR checks now

[giovannipizzi]

Thanks! What's the best way to get the version in conf.py? At the moment I import disk_objectstore that is clearly not installed. Should I play with the path (sys.path.append('..') or similar) or there are better ways?

[giovannipizzi]

Ok, everything fixed, now this is ready to be merged!