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

Update API Documentation Format #56

Closed
martindsouza opened this issue Feb 19, 2015 · 3 comments
Closed

Update API Documentation Format #56

martindsouza opened this issue Feb 19, 2015 · 3 comments
Assignees
@martindsouza
Labels
Documentation
Milestone
Release 3.0.0

Comments

@martindsouza
Copy link
Member

From @martindsouza on October 22, 2013 11:30

See http://ivaynberg.github.io/select2/ for an idea. Don't need to follow everything however I like how they do the syntax and parameter table. This would remove those headers and save space on the page.

Copied from original issue: tmuth#55
@martindsouza
Copy link
Member Author

Decided against doing it as it would add additional complexity do the API documentation file.

@martindsouza martindsouza self-assigned this Feb 19, 2015
@martindsouza martindsouza mentioned this issue Feb 19, 2015
Closed
@martindsouza martindsouza added this to the Release 2.2.0 milestone Feb 19, 2015
@martindsouza martindsouza reopened this Feb 20, 2015
martindsouza added a commit that referenced this issue Mar 7, 2015
@martindsouza
#56 improve documentation format
3e24049
martindsouza added a commit that referenced this issue Mar 7, 2015
@martindsouza
#56 Added google analytics for API docs
4398ef5
@martindsouza
Copy link
Member Author

Going to use FlatDoc instead: https://github.com/rstacruz/flatdoc http://ricostacruz.com/flatdoc/

martindsouza added a commit that referenced this issue Mar 7, 2015
@martindsouza
#56 Minor ui changes
1c49360
martindsouza added a commit that referenced this issue Mar 7, 2015
@martindsouza
#56 Minor API changes
cce29f1
@martindsouza
Copy link
Member Author

Updated installation and api docs to recommend flatdoc. Also took out their TOCs since flatdoc handles it nicely.

@martindsouza martindsouza modified the milestones: Release 2.2.0, Release 3.0.0 Mar 12, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@martindsouza martindsouza

Labels
Documentation
Projects
None yet
Milestone
Release 3.0.0
Development

No branches or pull requests
1 participant
@martindsouza