Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add html documentation page to the toolbox with sphinx #118

Merged

Conversation

renaudjester
Copy link
Collaborator

Fix: CMT-17

By adding documentation.

Missing:

  • Some action to deploy the html (github pages, read the docs, some domain?)
  • Trigger the creation of the doc (precommit doesn't seem easy, otherwise maybe github action that commits)

@renaudjester renaudjester requested a review from uriii3 August 27, 2024 14:19
Comment on lines -1 to -3
"""
.
"""
Copy link
Collaborator

@uriii3 uriii3 Aug 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we keeping this file empty?

Comment on lines +1 to +11
/*
* doctools.js
* ~~~~~~~~~~~
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
"use strict";
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wow I have no idea about javascript hahah, but seems semi understandable the logic

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how come we have the same gif repeated twice on the code? is there one that is redundant?

@uriii3
Copy link
Collaborator

uriii3 commented Aug 28, 2024

Nice work, with the creation of it and the rewording to make it readable and everything, it will be awesome!

Guess we will have to discuss what you point as to do and that will be it!

@renaudjester renaudjester force-pushed the copernicusmarine-toolbox-v2 branch from 4ef9bb9 to 84d2dd3 Compare August 29, 2024 10:37
@renaudjester renaudjester force-pushed the documentation-of-the-toolbox branch from c0b5db0 to 2ecd9da Compare August 29, 2024 10:45
@renaudjester renaudjester merged commit e3f1b7f into copernicusmarine-toolbox-v2 Aug 29, 2024
2 checks passed
@renaudjester renaudjester deleted the documentation-of-the-toolbox branch August 29, 2024 12:38
renaudjester added a commit that referenced this pull request Oct 28, 2024
first commit with some html documentation of the toolbox
renaudjester added a commit that referenced this pull request Oct 28, 2024
first commit with some html documentation of the toolbox
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants