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.

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

Change API documentation to GFM #31

Open
MiSikora opened this issue Oct 26, 2020 · 2 comments
Open

Change API documentation to GFM #31

MiSikora opened this issue Oct 26, 2020 · 2 comments
Labels
Blocked Cannot be proceeded with Documentation Improvements or additions to documentation

Comments

@MiSikora
Copy link
Owner

Dokka should provide GFM output that can be used by MkDocs to deploy it to the website.
@MiSikora MiSikora added Documentation Improvements or additions to documentation Blocked Cannot be proceeded with labels Oct 26, 2020
@MiSikora
Copy link
Owner Author

MiSikora commented Oct 26, 2020 •
edited
Loading

Right now Dokka 1.4.10.2 produces horrendous output. Will revisit this some time in the future.

Or I can write a script that polishes Dokka output.

@MiSikora
Copy link
Owner Author

MiSikora commented Dec 4, 2020

Output got a little bit better with 1.4.20 (still not perfect but manageable). However it still documents inherited methods or fields (including package private ones) and so on.

@MiSikora MiSikora changed the title Add API documentation to project site Change API documentation to GFM Dec 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Blocked Cannot be proceeded with Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MiSikora