Updated docs for release 0.1.0

jtniehof commented 2 years ago

This is a build of the docs as of #123, i.e release 0.1.0. This is using the latest Sphinx (4.4.0) so there are quite a few differences just due to that, plus of course the docs have been completely restructured (#94, #102, #112). The diffs are likely to be useless. Should be able to preview (although might be only one page at a time, and the CSS looks funky) at https://htmlpreview.github.io/?https://github.com/jtniehof/dbprocessing/blob/website-0.1.0/index.html

Of course, can also just download the whole thing as a zip and look at it that way.

This should be merged at the same time as #123. If the CI checks block the merge after approval, I can disable them briefly. I wish it wouldn't try to run if there's no config file...

PR Checklist

[X] Pull request has descriptive title
[X] Pull request gives overview of changes
[X] (N/A) New code has inline comments where necessary
[X] (N/A) Any new modules, functions or classes have docstrings consistent with dbprocessing style
[X] (N/A) Major new functionality has appropriate Sphinx documentation
[X] (N/A) Added an entry to release notes if fixing a major bug or providing a major new feature
[X] (N/A) New features and bug fixes should have unit tests
[X] Relevant issues are linked in the description (use Closes # if this PR closes the issue, or some other reference, such as See # if it is related in some other way)

jtniehof commented 2 years ago

Oh dear, I don't like that it's trying to run CI against this, we may just need to disable CI to do the doc merges, at least short-term.

jtniehof commented 2 years ago

The table of content appears at the bottom of the page on firefox.

Which page, and which version of Firefox? Can you get a screenshot?

Note any updates to this would go into the next release, since you merged #123...that can of course happen very rapidly.

EDIT: If this is happening in the preview, ignore it...it's not terribly reliable.

jtniehof commented 2 years ago

Here's the link to download a zip. Just unzip and open index.html in a browser.

dnadeau-lanl commented 2 years ago

This is the firefox I am using

You can see the TOC at the bottom of the page here.

jtniehof commented 2 years ago

This is the firefox I am using

You can see the TOC at the bottom of the page here.

That's the HTML preview. As I noted, the CSS doesn't really work in the preview, and I shouldn't have linked it. Grab the zip.

dnadeau-lanl commented 2 years ago

I just tried the zip and it works. I missed that comment about CSS. I'll merge shortly.

jtniehof commented 2 years ago

Awesome, thanks! Then I'll do the other bits. (EDIT: once merged)

jtniehof commented 2 years ago

Thanks!

spacepy / dbprocessing

Updated docs for release 0.1.0 #124

PR Checklist