Docs #266

tony · 2020-08-02T03:23:42Z

mkdocs API stuff: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins#api-documentation-building

codecov · 2020-08-02T03:24:27Z

Codecov Report

Merging #266 into master will increase coverage by 0.01%.
The diff coverage is 75.00%.

@@            Coverage Diff             @@
##           master     #266      +/-   ##
==========================================
+ Coverage   85.57%   85.59%   +0.01%     
==========================================
  Files          16       16              
  Lines         804      805       +1     
==========================================
+ Hits          688      689       +1     
  Misses        116      116

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	`95.31% <100.00%> (ø)`

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...11b0e6a. Read the comment docs.

Set this manually in CI See also: https://github.com/python-poetry/poetry/blob/master/.github/workflows/main.yml

make build_docs make serve_docs make watch_docs make dev_docs

pandoc --from rst --to gfm CHANGES --atx-headers | \ sed s/"<"/"\("/g | sed s/">"/"\)"/g | \ sed s/"- "/"- "/g > tmp; mv tmp CHANGES

…ncluded See also: - tony/mkapi#1 - daizutabi/mkapi#23 - daizutabi/mkapi#24

See also: - https://pypi.org/project/mkapi-git-pull/ - python-poetry/poetry#2176 - python-poetry/poetry#2391

Includes fix for daizutabi/mkapi#27

…fault" This reverts commit a94cd4f.

tony changed the title ~~Add portray~~ Docs Aug 2, 2020

tony force-pushed the new-docs branch 16 times, most recently from 2d0cb69 to 3387414 Compare August 2, 2020 17:59

tony mentioned this pull request Aug 4, 2020

New docs, with sphinx + markdown #267

Merged

tony force-pushed the master branch from f5f075b to b7ae236 Compare August 5, 2020 21:30

tony added 10 commits August 5, 2020 21:00

Add portray

6131648

Add example to see if we're pushing/invalidating automatically

0269ba5

build(gitignore): Ignore .updated_files

fd79bce

ci(poetry): Remove virtualdirs being configured locally by default

46baee4

Set this manually in CI See also: https://github.com/python-poetry/poetry/blob/master/.github/workflows/main.yml

Add github publish action

da881da

ci(libvcs): Cache, use .venv with poetry

291abdb

Add art/ directory with symlinks to old static files

8d2cc98

portray: Add logos and favicon, theme colors

ab8e087

build(portray): remove

637cf11

build(mkdocs): Add mkdocs package

2efbe0b

tony added 27 commits August 5, 2020 21:00

style(CHANGES): Use markdown (vim highlighting only atm)

598f326

docs(history): Symlink to CHANGES (mkdocs)

d9c80b6

build(Makefile): Watch css files in doc watcher

5203b3f

style(libvcs.git): Begin transitioning rST to markdown

98def4e

style(mkdocs/mkapi): Add styling to make font size smaller

0d8cf1a

Remove api.md, use mkapi's autogenerated stuff

fd99567

build(sphinx): Remove reStructuredText files

d2c5163

chore(images): Move favicon/logo to assets/images

835f50d

chore(docs/Makefile): Remove, in favor of root Makefile commands

c5babb6

make build_docs make serve_docs make watch_docs make dev_docs

build(README): Use README.md instead of README.rst

01aa77f

ci(codecov): Ignore changes less than 0.1%

49eb1bb

ci(codecov): Try another tweak to quiet codecov down

704a518

style(mkdocs/mkapi): CSS Tweaks to make font size smaller

4265026

style(CHANGES): Reformat to markdown with pandoc / sed(1)

919c28b

pandoc --from rst --to gfm CHANGES --atx-headers | \ sed s/"<"/"\("/g | sed s/">"/"\)"/g | \ sed s/"- "/"- "/g > tmp; mv tmp CHANGES

build(mkapi): Use forked version with trailing slash fix, other PRs i…

9b5bf15

…ncluded See also: - tony/mkapi#1 - daizutabi/mkapi#23 - daizutabi/mkapi#24

build(poetry): poetry lock

34e9968

build(libvcs): Use pypi fork

d4d9289

See also: - https://pypi.org/project/mkapi-git-pull/ - python-poetry/poetry#2176 - python-poetry/poetry#2391

docs: Add instructions for editing documentation

73e2f00

docs(mkdocs): Add developing.md to navbar

1aeaa3d

build: ignore .vim/

d6e369c

docs(hg,svn,util,shortcuts): Update to use markdown, numpy styling

e3fc2cb

build(mkapi): Update fork to 1.0.12post1

7a947dc

Includes fix for daizutabi/mkapi#27

docs(base): Port to markdown, numpy styling

7837f34

docs: Remove tilde style header

99f3bb5

docs(git): Remove admonitions, fix return types

009e230

Revert "ci(poetry): Remove virtualdirs being configured locally by de…

dbd630c

…fault" This reverts commit a94cd4f.

build(publish-docs): Only invalidate html files

11b0e6a

tony force-pushed the new-docs branch from 415f252 to 11b0e6a Compare August 6, 2020 02:05

tony merged commit 11b0e6a into master Aug 6, 2020

tony deleted the new-docs branch August 13, 2020 22:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs #266

Docs #266

tony commented Aug 2, 2020 •

edited

Loading

codecov bot commented Aug 2, 2020 •

edited

Loading

Docs #266

Docs #266

Conversation

tony commented Aug 2, 2020 • edited Loading

codecov bot commented Aug 2, 2020 • edited Loading

Codecov Report

tony commented Aug 2, 2020 •

edited

Loading

codecov bot commented Aug 2, 2020 •

edited

Loading