Skip to content
This repository has been archived by the owner on Oct 8, 2023. It is now read-only.

From markdown to restructuredtext #199

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

stop5
Copy link

@stop5 stop5 commented Aug 30, 2018

  • Fork the repository and create your branch from master.
    based on master

  • Run the build.py and test.py scripts.
    Same output like master

  • If you are fixing something, add tests that fail in the current version and pass in yours.

  • If you're developing a new feature open an issue first to discuss it. Some features may be useful to you but harmful to others be it because of performance, new dependencies or different perspectives.
    Issue #138

  • Ensure the entire test suite is passing and overall performance is not degraded.
    good docs make the development faster

The last commit will contain the theme and similar options.

Sebastian Tobie added 3 commits August 30, 2018 15:40
Parser cleanup

its bad style to set __all__ with values that doesnt exist.
Its confusing.

Signed-off-by: Sebastian Tobie <[email protected]>
cython now embeds docstrings into the binary.

If we document the cython pyx and pxd, the hints files are obsolete
and stop breaking sphinx. And we dont need two implementations of
the same class.

Signed-off-by: Sebastian Tobie <[email protected]>
the big

I reformated the markdown files to restrucured Text and
putted them into docs/docs.
The docs/api directory has the required files for the
automatic documentation of the modules.

sphinx-autodoc-typehints adds the typehints to the docs.

Signed-off-by: Sebastian Tobie <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant