Skip to content

Adding sphinx docs & minor improvements to the README #23

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.

Sign up for GitHub

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

Jump to bottom
Open
cbjuan wants to merge 33 commits into
base: main
Choose a base branch
from
Open

Adding sphinx docs & minor improvements to the README #23

cbjuan wants to merge 33 commits into from

Conversation

@cbjuan
Copy link
Member

@cbjuan cbjuan commented Sep 2, 2025

Fixes #22

This PR adds better documentation to the library through creating a Sphinx website. It also includes the GitHub workflows to deploy it in https://ai4quantum.github.io/twisteRL

@cbjuan cbjuan self-assigned this Sep 2, 2025
github-actions bot added a commit that referenced this pull request Sep 2, 2025
@github-actions
Deploy PR #23 preview
35e605e
@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2025

📖 Documentation Preview

The documentation for this PR is available at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

github-actions bot added a commit that referenced this pull request Sep 2, 2025
@github-actions
Deploy PR #23 preview
16fd57d
@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2025

📖 Documentation Preview

The documentation for this PR is available at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

github-actions bot added a commit that referenced this pull request Sep 2, 2025
@github-actions
Deploy PR #23 preview
20ecf00
@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

@cbjuan cbjuan marked this pull request as draft September 4, 2025 13:36
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

github-actions bot added a commit that referenced this pull request Sep 4, 2025
@github-actions
Deploy PR #23 preview
c5606bf
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

github-actions bot added a commit that referenced this pull request Sep 4, 2025
@github-actions
Deploy PR #23 preview
8c35daa
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

github-actions bot added a commit that referenced this pull request Sep 4, 2025
@github-actions
Deploy PR #23 preview
3d4fd20
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

@cbjuan
Updating actions/download-artifact version to v4. Adding PR previews …
587764d 
…options

Removing unneeded steps

Fixing errors and warnings in the GH action

Adding docs preview for PRs

Creating & managing the gh-pages if it does not exist before

Fixing the path for styles /CSS files in PR previews

Improving GH bot messaging

Trying to fix the visualization of styles in PR previews

trying to fix CSS in PR previews again

Trying to fix the styles again in the PR preview

Still fighting to show the styles in PR previews

Another attempt to fix styles in PR previews

Fixing GH event for PR preview

Another attempt to fix styles in PR previews

Another attempt

New attempt

New attempt

Fixing sphinx config

New attempt

New attempt

Attempt

Attempt

Adding .nojekyll file to try to avoid the issues with the _static folder & gh-pages

Fixing the styles for the /api docs path

Fixing URL paths for style viz under /api URL

REmoving debug info
@cbjuan
Merge branch 'adding-sphinx-docs' of https://github.com/IBM/twisteRL …
3f0e049 
…into adding-sphinx-docs

# Conflicts:
#	.github/workflows/docs.yml
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

@cbjuan cbjuan marked this pull request as ready for review September 4, 2025 16:03
@cbjuan
Copy link
Member Author

cbjuan commented Sep 4, 2025

Ready for review, @victor-villar. Will squash everything at merging time to clean up the Git history

@d-kremer
Copy link
Collaborator

d-kremer commented Sep 5, 2025

The structure seems OK but most files in the docs folder need a very deep review and rewriting. I was not able to find a single example that works, and there is also a lot of things like this that we may need to refine:

Planned for future releases:

  • A3C/A2C: Asynchronous advantage actor-critic methods
  • SAC: Soft Actor-Critic for continuous control
  • TD3: Twin Delayed Deep Deterministic Policy Gradient
  • Rainbow DQN: Improved deep Q-learning with multiple extensions

@github-actions
Copy link
Contributor

github-actions bot commented Dec 11, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

github-actions bot added a commit that referenced this pull request Dec 11, 2025
@github-actions
Deploy PR #23 preview
582d74e
github-actions bot added a commit that referenced this pull request Dec 12, 2025
@github-actions
Deploy PR #23 preview
9b34f4f
@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

github-actions bot added a commit that referenced this pull request Dec 12, 2025
@github-actions
Deploy PR #23 preview
0c92759
@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2025

📖 Documentation Preview

The documentation for this PR is available (or will be shortly) at:
🔗 https://AI4quantum.github.io/twisteRL/pr-23/

This preview is automatically updated when you push changes to this PR.

github-actions bot added a commit that referenced this pull request Dec 12, 2025
@github-actions
Deploy PR #23 preview
cda81cc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@d-kremer d-kremer Awaiting requested review from d-kremer d-kremer is a code owner

@victor-villar victor-villar Awaiting requested review from victor-villar victor-villar is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@cbjuan cbjuan

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve documentation

2 participants

@cbjuan @d-kremer