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

[RFE] Better structure for documentation #51

Open

jan-zmeskal opened this issue Jul 16, 2018 · 1 comment

Assignees

Labels

enhancement good first issue

Milestone

Collaborator

jan-zmeskal commented Jul 16, 2018

There are two problems with documentation that we should get rid of. If you build it locally, then

Even though it is built in the end, you get a lot of error
Sources and build outputs are stored in the same location. Git percieves the newly built docs as untracked files. We should create special destination for build docs that would be ignored by git. That's the convention with sphinx docs as far as I know.

jan-zmeskal added enhancement good first issue labels

jan-zmeskal added this to the POC milestone

jan-zmeskal changed the title ~~Better structure for documentation~~ [RFE] Better structure for documentation

jan-zmeskal self-assigned this

Collaborator Author

jan-zmeskal commented Jul 24, 2018

PR: #53

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment