Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Gatsby: Python packages source, intersphinx source#269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
tony wants to merge86 commits intomaster
base:master
Choose a base branch
Loading
fromgatsby-docs

Conversation

@tony
Copy link
Member

@tonytony commentedAug 7, 2020
edited
Loading

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 added30 commitsAugust 5, 2020 21:00
for rst in **/*.rst; do pandoc "$rst" -f rst -t gfm -o "${rst%.*}.md"; done
poetry remove --dev doc8 alagitpull docutils sphinx-issues sphinx
poetry add mkapi --dev --python ">=3.7" -E docs
poetry add mkdocs --dev --python ">=3.5" -E docspoetry add mkdocs-material --dev --python ">=3.5" -E docs
tony added10 commitsAugust 6, 2020 16:37
poetry add sphinx-issues --dev --extras docs --optionalpoetry add alagitpull --dev --extras docs --optional --allow-prereleases
…numpy format (#267)- Move sphinx format to Numpy-style- Move from reStructuredText to Markdown (via recommonmark). The master plan is to eliminate  docutils and sphinx as a bottleneck completely in favor of something else (e.g. gatsby with  a source that inspects our modules and can source intersphinx)- Move from RTD to GitHub Action, full support of poetry extras packages, deploys straight to   S3 and CloudFront
@codecov
Copy link

codecovbot commentedAug 7, 2020
edited
Loading

Codecov Report

Merging#269 (03a32e0) intomaster (1ee8026) willdecrease coverage by0.72%.
The diff coverage is75.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 FilesCoverage Δ
libvcs/exc.py100.00% <ø> (ø)
libvcs/git.py68.94% <ø> (ø)
libvcs/hg.py100.00% <ø> (ø)
libvcs/svn.py68.42% <ø> (ø)
setup.py0.00% <0.00%> (ø)
libvcs/base.py100.00% <100.00%> (ø)
libvcs/shortcuts.py100.00% <100.00%> (ø)
libvcs/util.py87.50% <100.00%> (-7.82%)⬇️
tests/test_git.py98.43% <0.00%> (-0.79%)⬇️

Continue to review full report at Codecov.

Legend -Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered byCodecov. Last update1ee8026...03a32e0. Read thecomment docs.

@tonytonyforce-pushed themaster branch 3 times, most recently from5354b23 toeffff43CompareJuly 13, 2022 21:24
@tonytonyforce-pushed themaster branch 4 times, most recently fromcf9f3ef to410e041CompareMay 27, 2023 13:25
@tonytonyforce-pushed themaster branch 2 times, most recently from7f69eab toc480bb4CompareNovember 24, 2024 15:12
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tony

[8]ページ先頭

©2009-2025 Movatter.jp