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

New Docs PR #903

Closed
wants to merge 7 commits into from
Closed

New Docs PR #903

wants to merge 7 commits into from

Conversation

ramonpzg
Copy link

@ramonpzg ramonpzg commented Oct 2, 2024

This PR contains the necessary changes to migrate to our new documentation platform, GitBook.

Previously, all notebooks were exported as markdown files during CI. Now, we will need to make changes to the notebooks and export them to a markdown file before committing the changes.

If you update 1 notebook you could use the quarto CLI and run the following command to update it from the terminal.

quarto convert overview.ipynb -o overview.md

If you update many notebooks and you want to convert them all at once, you can run the following command on the terminal.

for nb in *.ipynb; do 
  base_name="${nb%.ipynb}"
  quarto convert "$nb" -o "$base_name.md"
done

All files from the doc/source directory have been moved one lovely up, and all files related to readthedocs or sphinx have been deleted.

No changed have been made to the CI/CD pipeline. If we are running a command or several related to readthedocs and/or sphinx, these will need to be removed.

Lastly, there are no API references in this new documentation. These can be added later on or users can go to the source code to learn more about the implementation of a method.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@paulb-seldon
Copy link
Contributor

A couple of initial notes:

  • Any of the pages with {tab-item} (how read the docs does tab blocks) don't migrate well to gitbook (see the 'Getting Started' page)
  • Latex or equations formatting doesn't translate between readthedocs and gitbook (see the Adversarial Auto-Encoder example)
  • Does gitbook support syntax highlighting across languages? I can see for some of the python code blocks we don't really have it but would good for that to be consistent

@sakoush
Copy link
Member

sakoush commented Oct 15, 2024

This PR should not overwrite docs, instead the new changes should go to docs-gb as with other workflows we have.
This will by extension fix the merge conflicts above.

@Rajakavitha1
Copy link

A couple of initial notes:

  • Any of the pages with {tab-item} (how read the docs does tab blocks) don't migrate well to gitbook (see the 'Getting Started' page)
  • Latex or equations formatting doesn't translate between readthedocs and gitbook (see the Adversarial Auto-Encoder example)
  • Does gitbook support syntax highlighting across languages? I can see for some of the python code blocks we don't really have it but would good for that to be consistent

Hi @paulb-seldon this is on my to do list post migration.

@Rajakavitha1
Copy link

This PR should not overwrite docs, instead the new changes should go to docs-gb as with other workflows we have. This will by extension fix the merge conflicts above.

hi @sakoush can you please help me with this move to docs-gb . I am afraid that I might mess up the folders. Could you please do this.

@sakoush sakoush mentioned this pull request Oct 15, 2024
@sakoush
Copy link
Member

sakoush commented Oct 15, 2024

superseded by #904

@sakoush sakoush closed this Oct 15, 2024
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.

5 participants