Skip to content
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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Research the magic of scikit-learn docs #29

Open
emican opened this issue Feb 8, 2021 · 3 comments
Open

Research the magic of scikit-learn docs #29

emican opened this issue Feb 8, 2021 · 3 comments

Comments

@emican
Copy link
Contributor

emican commented Feb 8, 2021

No description provided.

emican added a commit that referenced this issue Feb 11, 2021
@emican
#29 Sphinx docs. See docs/_build/html/index.html
6fc0322
emican added a commit that referenced this issue Feb 12, 2021
@emican
#29 move docs folder to project root + regenerate
415bd97
@emican
Copy link
Contributor Author

emican commented Feb 12, 2021 •
edited
Loading

We can add ReSrtructured text to our docstrings, like scikit-learn, and then use Sphinx to generate beautiful documentation.

Todo:

  • A cheat sheet of examples common to this project
  • Basic workflow for adding new modules to docs

Docstring generators that support (PEP 484 - type hints):

@emican
Copy link
Contributor Author

emican commented Feb 13, 2021 •
edited
Loading

Additional research items:

emican added a commit that referenced this issue Feb 14, 2021
@emican
#29 Sphinx config, package.rst and make updates.
99c0e25 
Make has been adjusted to use whatever python your virtual env is using.
@emican
Copy link
Contributor Author

emican commented Feb 21, 2021

Additional research items:

Render math in documentation

.. math::

    qt=((yt-lt)-(h2-yt))/(ht-lt)*vt

qt represents an intermediate calculation called Money-Flow volume

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@emican