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.

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

Add sphinx Documentation #19

Open
gregorpirgie opened this issue Mar 21, 2023 · 1 comment
Open

Add sphinx Documentation #19

gregorpirgie opened this issue Mar 21, 2023 · 1 comment
Labels
Documentation Issue/pr relates to documentation enhancement New feature or request question Further information is requested

Comments

@gregorpirgie
Copy link
Contributor

Currently, there is no documentation included in source code, only the readme.

This relates to #18

Can we implement a basic sphinx documentation for bibsonomy, once the docstrings are added?

@gregorpirgie gregorpirgie added enhancement New feature or request question Further information is requested Documentation Issue/pr relates to documentation labels Mar 21, 2023
@gregorpirgie
Copy link
Contributor Author

gregorpirgie commented Mar 21, 2023

Before doing so, we might decide on #23 (if we want to rename the tool). Or at least keep this in mind while writing the documentation (linking the appname in the docs instead of writing it as a plain string whenever it occurs in the docs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issue/pr relates to documentation enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant