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

How to improve documentation? #838

Open
gam6itko opened this issue Mar 5, 2021 · 3 comments
Open

How to improve documentation? #838

gam6itko opened this issue Mar 5, 2021 · 3 comments

Comments

@gam6itko
Copy link
Contributor

gam6itko commented Mar 5, 2021

I don't see any CONTRIBUTING.md inside the project folder. Could you add a guidelines how to improve the documentation?

According to CONTRIBUTING.md in https://github.com/schmittjoh/serializer I've executed.

cd Resources/doc && sphinx-build -W -b html -d _build/doctrees . _build/html

but there is no conf.py file.

Please guide me.

@goetas
Copy link
Collaborator

goetas commented Mar 5, 2021

I think that you can copy the files from the serializer (https://github.com/schmittjoh/serializer/blob/master/doc/conf.py)

@goetas
Copy link
Collaborator

goetas commented Mar 5, 2021

schmittjoh/serializer#997 implemented the document build on the serializer library

@gam6itko
Copy link
Contributor Author

gam6itko commented Mar 25, 2021

@goetas how will docs deploy on the site?

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

2 participants