libvcs icon indicating copy to clipboard operation
libvcs copied to clipboard

Gatsby: Python packages source, intersphinx source

Open tony opened this issue 5 years ago • 1 comments

Eliminate dependency on docutils and sphinx. These are great projects, but they not friendly to configure on and focused primarily toward internal code API documentation.

Today - markdown is more commonplace and supports extensions better than docutils does and static site generators offer better inter-document linking than sphinx. For instance, gatsby supports intuitive, structured, comprehensive, detailed, typed and recursive sources in graphql, rather than the visitor pattern offered by docutils.

mkdocs, pdoc(3), and even non python documentation generators have a legitimate stakehold in making documentation portable.

Other sphinx projects (e.g. flask, standard library python) can still be linked to intersphinx

Python package source

https://github.com/readthedocs/sphinx-autoapi + https://github.com/PyCQA/astroid

Generate gatsby source by parsing a package into a JSON / YAML structure then into GraphQL

Intersphinx source

https://sphobjinv.readthedocs.io/en/latest/index.html

Parse objects.inv on projects into gatsby graphql source

MDX utilities to link to intersphinx sources

MDX utilities to link to python package sources

tony avatar Aug 07 '20 00:08 tony

Codecov Report

Merging #269 (03a32e0) into master (1ee8026) will decrease coverage by 0.72%. The diff coverage is 75.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #269      +/-   ##
==========================================
- Coverage   85.57%   84.84%   -0.73%     
==========================================
  Files          16       16              
  Lines         804      805       +1     
==========================================
- Hits          688      683       -5     
- Misses        116      122       +6     
Impacted Files Coverage Δ
libvcs/exc.py 100.00% <ø> (ø)
libvcs/git.py 68.94% <ø> (ø)
libvcs/hg.py 100.00% <ø> (ø)
libvcs/svn.py 68.42% <ø> (ø)
setup.py 0.00% <0.00%> (ø)
libvcs/base.py 100.00% <100.00%> (ø)
libvcs/shortcuts.py 100.00% <100.00%> (ø)
libvcs/util.py 87.50% <100.00%> (-7.82%) :arrow_down:
tests/test_git.py 98.43% <0.00%> (-0.79%) :arrow_down:

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 1ee8026...03a32e0. Read the comment docs.

codecov[bot] avatar Aug 07 '20 01:08 codecov[bot]