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

Make documentation (more) visible #25

Open
me-kell opened this issue Dec 1, 2022 · 0 comments
Open

Make documentation (more) visible #25

me-kell opened this issue Dec 1, 2022 · 0 comments

Comments

@me-kell
Copy link

me-kell commented Dec 1, 2022

The documentation is distributed in four .rst files and concatenated to the variable long_description
in setup.py (see below).

To make it easier to find the documentation put at least a link to those files. Better; generate docs.

long_description = (
    read('README.rst') +
    '\n' +
    read('plone', 'registry', 'registry.rst') +
    '\n' +
    read('plone', 'registry', 'events.rst') +
    '\n' +
    read('plone', 'registry', 'field.rst') +
    '\n' +
    read('CHANGES.rst') +
    '\n'
)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant