search

mdolab / pyhyp

pyHyp generates volume meshes from surface meshes using hyperbolic marching.
Other
45 stars 39 forks source link

moved options documentation to separate page #24

Closed sseraj closed 4 years ago

sseraj commented 4 years ago

Purpose

The options table is currently buried in the Plot3d tutorial. I moved the table to a separate page on the top level to increase visibility. This is consistent with the ADflow and IDWarp docs. I also added the text wrapping fix for the table.

Type of change

ewu63 commented 4 years ago

Currently, all the examples show up on a single page, despite CGNS and Plot3D being listed as separate pages on the side bar. Would you mind splitting it up into separate files so that they will render as separate pages? I think that's preferable to having a top-level heading called Example Usage or something and putting everything under that.

sseraj commented 4 years ago

I think this addresses the quote/backtick issues.

ewu63 commented 4 years ago

So technically all the single backticks should be double backticks, since we want the fixed width formatting for those. Would you mind doing that?

sseraj commented 4 years ago

The few extra characters wreaked havoc on the table formatting so I had to change the spacing. I split each sentence into its own line like we try to do with the docs.

sseraj commented 4 years ago

Travis is failing on py3-centos7-impi because: Error: Product support for your (Comp-FL) license has expired.

ewu63 commented 4 years ago

Thanks for that, table looks much more legible now. Yeah I'm not sure why the license expired, I thought we build that nightly. Anyways, I'm fine merging this in since it only touches the docs.

ewu63 commented 4 years ago

Yeah, now that we are rolling out the CSS "hack" for tables, I am much more inclined to throw that in a repo and upload it to pyPI. Will comment on the appropriate issue and elicit help.