massive documentation normalization and restructuring #849
Conversation
There was a problem hiding this comment.
Looks great! @sosey is our hero!
One thing I notice is that the sphinx-automodapi package mangles the ConfigObject spec attributes in the various step classes, escaping the formatting.
docs/conf.py
Outdated
|
|
||
| # The name of an image file (relative to this directory) to place at the top of | ||
| # the title page. | ||
| latex_logo = '_static/wfc_logo.png' |
There was a problem hiding this comment.
This wfc_logo.png file doesn't exist in the repository and causes the latexpdf build to barf. The stsci_pri_combo_mark_white.png one works as a replacement, but probably a different one with black text would be better for the pdf doc.
There was a problem hiding this comment.
doh - found a jwst logo to use instead 馃槃
|
Should update |
asked @mdboom if he knew of a way to render the multi-line spec strings from the code with the linebreaks, it wasn't too apparent to me how to get that done. |
|
I added sphinx-automodapi as a pip dependency on travis, baffled as to why the doc test keeps failing |
.travis.yml
Outdated
| CONDA_DEPENDENCIES=$CONDA_JWST_DEPENDENCIES | ||
| PIP_DEPDENDENCIES='sphinx_rtd_theme sphinx-automodapi' |
There was a problem hiding this comment.
@sosey There's a typo here 馃槃 -> "PIP_DEPENDENCIES"
.gitignore
Outdated
| @@ -11,5 +11,7 @@ dist/ | |||
| docs/*/source/*.txt.rst | |||
| docs/fits_generator/source/templates.rst | |||
| docs/jwst_git/ | |||
| docs/_build/ | |||
| doc/api/ | |||
There was a problem hiding this comment.
Typo here. Should be docs/api/.
|
@hbushouse @nden I have a squash commit waiting to push before the final merge, but all the tests are passing now, would be nice to merge this today before there are more doc changes 馃槃 |
|
I haven't been able to build and look at the results yet, but if you think things are to the point of them building correctly in the auto environment, then I say "go for it". |
|
We should come up with a common style for all packages. Also let's open issues for all packages which built with warnings. |
This is a large change. The whole doc package now builds as one.
Otherwise, give this a go and see if it works for people other than me 馃幈
Also, give your own package a look and see if anything is glaringly wrong or missing.
Feel free to make it prettier, but lets merge this first if everyone agrees and then do that?
@hbushouse