appliedai-initiative / pymetrius Goto Github PK

While performing an initial setup is useful, it can take long. The user should have the possibility to skip it and to perform env setup and formatting on their own later

Update: See #8. Let's NOT use sphinx
Update: There is something called sphinx-multiversion

Manual approach:

• For each stable release, add a new folder vx.x.x in the branch gh-pages
• Base URL for all links within a release's docs should be properly set
• Create a root index.html with a redirect to the latest release

Sphinx is a constant source of indescribable pain and frustration. Countless hours wasted staring at bogus error messages because of a missed white space somewhere or something even more idiotic. Almost infinite build times consuming the forests of the Earth.

If mkdocs supports bibtex and latex-style dollar inline math, let's switch and never look back

Much nicer than the current coverage report as html

Make it a dependency, and check in the release script that no deprecated methods are left behind in a release. deprecation allows marking the moment something is tagged for deprecation and the release at which it will be removed, e.g.

@deprecated(
    deprecated_in="0.6.0",
    removed_in="0.7.0",
    details="This class has been renamed. Use StandardErrorRatio instead",
)
class StandardError(StandardErrorRatio):
    pass

urgently! 😄

The report should be published as html pages, same as pylint report

The config is to be decided on, maybe this example can be taken as starting point.