Kevin Turner

Results 201 comments of Kevin Turner

Current directions: * use Read the Docs * use Sphinx (not MkDocs) * do keep docs-building requirements separate from end-user installation requirements

* keep top-level project README in Markdown * use reStructuredText for things in `docs/` (including content that's factored out of README)

How do we keep the version in docs/conf.py:release in sync with the one in pandas_vet.version?

The [Read the Docs feature flag](https://docs.readthedocs.io/en/stable/guides/feature-flags.html) is `EXTERNAL_VERSION_BUILD`. Which really is probably what you want long-term. This particular branch is going to be especially heavy on sphinx-config-twiddling, but in general,...

On the GitHub side, there's [branch protection](https://help.github.com/en/github/administering-a-repository/enabling-branch-restrictions) to enabled a collaborator to fiddle with a side branch in the main repo without being able to push to a release branch....

# autodoc vs autoapi autodoc is the standard, shipped with sphinx. The distinguishing feature of autoapi is that it parses the source, instead of importing (evaluating) it as autodoc does....

Okay, as far as the build process goes, things are looking pretty good on this end. Still need to confirm the RTD build server feels the same way. Aside from...

- [ ] Should we keep the Makefile? docs/Makefile and docs/make.bat were created by sphinx-quickstart. The Makefile, however, doesn't have any real targets or build rules in it, it's just...

the linkcheck fail is because GitHub gets tricky when rendering embedded markdown. See https://github.com/sphinx-doc/sphinx/issues/6779

Not sure how you'd like to handle this. The thing that seems most obvious to me is for `ColorfulStyle.evaluate` to `str()` everything that comes in, so that ColorfulString.orig_string is always...