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

Improve documentation #70

Merged
merged 97 commits into from
Mar 20, 2024
Merged

Improve documentation #70

merged 97 commits into from
Mar 20, 2024

Conversation

juanep97
Copy link
Owner

@juanep97 juanep97 commented Jan 9, 2024

This PR improves the documentation, adding several notebook examples.

The notebooks are implemented in 'pct' format, a fully text-based and human-readable format that is also valid Python code. They are automatically converted from pct format to usual ipynb by jupytext and executed by MyST-NB. They can be browsed as part of the normal documentation, they are integrated in the Sphinx docs through:

extensions = [
    'myst_nb',
    "nbsphinx",
]

...

nb_custom_formats = {
    '.py': ['jupytext.reads', {'fmt': 'py:percent'}],
}

It also documents how to set up IOP4 for production (in a public server).

As of now the docs use the test dataset and catalog.

@juanep97 juanep97 added the documentation Improvements or additions to documentation label Jan 9, 2024
@juanep97 juanep97 marked this pull request as draft January 9, 2024 14:37
@juanep97 juanep97 changed the title Improve docs [WIP] Improve docs Jan 9, 2024
@juanep97
Copy link
Owner Author

juanep97 commented Jan 9, 2024

@morcuended what do you recommend between available options (.ipynb + nbspinx, .myst + myst_nb, .py + sphinx-gallery)?

@morcuended
Copy link
Collaborator

maybe sphinx-gallery?

@morcuended
Copy link
Collaborator

so what's the problem with the downloading of test data? does it have a new checksum?

@juanep97
Copy link
Owner Author

so what's the problem with the downloading of test data? does it have a new checksum?

It didn't set the credentials and checksum right, I think it will be solved in this CI run.

morcuended
morcuended previously approved these changes Mar 20, 2024
@juanep97
Copy link
Owner Author

If these the tests pass, I think it is good enough for now. We can keep improving the docs in other PRs with more example notebooks, etc.

@juanep97 juanep97 changed the title Improve docs Improve documentation Mar 20, 2024
Copy link
Collaborator

@morcuended morcuended left a comment

Choose a reason for hiding this comment

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

Sure, this is good to go already. Great job

@juanep97 juanep97 merged commit 6a003f0 into main Mar 20, 2024
3 checks passed
@juanep97 juanep97 deleted the improve_docs branch April 15, 2024 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants