search

encode / apistar

The Web API toolkit. 🛠
https://docs.apistar.com
BSD 3-Clause "New" or "Revised" License
5.57k stars 411 forks source link

Better rendering for view docstrings #576

Closed aleksarias closed 6 years ago

aleksarias commented 6 years ago

Adds ability to render html formatting that may be included in doc strings

tomchristie commented 6 years ago

Yup seems valid - just wondering which other places we ought to be doing the same?

aleksarias commented 6 years ago

Right now this is the only place I can think of. In the future, if we include a section that details the response of an API endpoint... we should include the feature there too.

aleksarias commented 6 years ago

@tomchristie, what do you think about setting the width of the docs-content pane to the minimum width where pep8 length compliant lines fit within the pane without wrapping? Users would have to wrap the lines they won't to be "formatted like code" with <code> blah.. </code>

I've done it on one of my projects like this: 

.docs-content {
    min-width: 725px;
}
code {
    white-space: pre;
    font-size: 12px;
}
aleksarias commented 6 years ago

@tomchristie, is this something that should be merged? Let me know if there any other changes that should be made in order to merge.

tomchristie commented 6 years ago

Closing this off given that 0.6 is moving to a framework-agnostic suite of API tools, and will no longer include the server. See https://discuss.apistar.org/t/api-star-as-a-framework-independant-tool/614 and #624.