search

matthewholman / assist

ASSIST is a software package for ephemeris-quality integrations of test particles.
https://assist.readthedocs.io/
GNU General Public License v3.0
24 stars 10 forks source link

mkdocs #69

Closed hannorein closed 1 year ago

hannorein commented 1 year ago

@matthewholman and @aryaakmal, have a look and let me know your thoughts on #68. Here's a demo: https://assist-demo.readthedocs.io/en/latest/

aryaakmal commented 1 year ago

I look forward to seeing what this looks like on readthedocs. One thing about the sphinx version that I did like was that it was easy to add links to the index by simply adding to the body of the index file - and sphinx incorporated them in the left panel automatically. It isn't completely clear to me looking at the files how that would work here ... I have zero familiarity with javascript. But I assume it will be straightforward to figure it out once there is a template to follow.

On Tue, Feb 14, 2023 at 5:12 PM Hanno Rein @.***> wrote:

@matthewholman https://github.com/matthewholman and @aryaakmal https://github.com/aryaakmal, have a look and let me know your thoughts on #68 https://github.com/matthewholman/assist/issues/68. Here's a demo: https://assist-demo.readthedocs.io/en/latest/

  • The main difference is that the source of the documentation is just markdown which I find easier to read and work with.
  • The documentation now includes all the c and python examples, including the images from the notebooks. Everything is automatically generated. If we want to include a new example, we only need to edit the mkdocs.yml https://github.com/hannorein/assist/blob/mkdocs/mkdocs.yml file.
  • The installation page for c and python is the same, you can select either c or python in the little tabs on the page to see the different syntax (I think that neat).
  • I'd like to add one or two extra pages which describe the various settings (how to forces turned on and off, etc)

You can view, comment on, or merge this pull request online at:

https://github.com/matthewholman/assist/pull/69 Commit Summary

File Changes

(24 files https://github.com/matthewholman/assist/pull/69/files)

Patch Links:

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/pull/69, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ42HSEJKJ4UKL2DYQLWXP7LXANCNFSM6AAAAAAU4DM54Y . You are receiving this because you were mentioned.Message ID: @.***>

hannorein commented 1 year ago

I don't think I understand. There is no javascript involved. This is probably not what you're asking but to add an item to the table of contents you simple add a file to the docs/ directory and add one line with the new file's name to mkdocs.yml.

aryaakmal commented 1 year ago

I'll just wait and see - I am sure it will be ok. But I do not see the mkdocs.yml file. I do see some new directories under your docs/ directory, including a javascripts/ directory containing a number of .js files ...

Ok, I see the mkdocs.yml file, which references the javascript.

On Tue, Feb 14, 2023 at 5:37 PM Hanno Rein @.***> wrote:

I don't think I understand. There is no javascript involved. This is probably not what you're asking but to add an item to the table of contents you simple add a file to the docs/ directory and add one line with the new file's name to mkdocs.yml.

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/pull/69#issuecomment-1430479504, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ6VJS5SVOTBMZDENB3WXQCKPANCNFSM6AAAAAAU4DM54Y . You are receiving this because you were mentioned.Message ID: @.***>

hannorein commented 1 year ago

The yml file is linked in the first comment on this PR (see above). I'm not sure why you're not seeing the file. The javascript is only for rendering LaTeX equations - but it's just for rendering - no need to ever touch the javascript part

aryaakmal commented 1 year ago

Yup, got it.

On Tue, Feb 14, 2023 at 5:51 PM Hanno Rein @.***> wrote:

The yml file is linked in the first comment on this PR (see above). I'm not sure why you're not seeing the file. The javascript is only for rendering LaTeX equations - but it's just for rendering - no need to ever touch the javascript part

— Reply to this email directly, view it on GitHub https://github.com/matthewholman/assist/pull/69#issuecomment-1430496883, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOMJBQ34IP2R7GEAAL7WVDDWXQEARANCNFSM6AAAAAAU4DM54Y . You are receiving this because you were mentioned.Message ID: @.***>

matthewholman commented 1 year ago

@hannorein, @aryaakmal, the documentation is looking really good!