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

Write python script to generate a sphinx theme from a saved html page #39

Open
19 tasks
Thecarisma opened this issue Apr 23, 2022 · 0 comments
Open
19 tasks

Comments

@Thecarisma
Copy link
Owner

Thecarisma commented Apr 23, 2022

Create a python script that auto-generates an HTML page as distributable and installed the sphinx theme. Use the script to generate a new theme for thematic collection and allow the script to be capable of generating a single sphinx theme for a saved HTML page.

Scenario 1

If the page https://docs.github.com/en is saved as HTML, the script will generate a sphinx theme that can generate a doc in the save Github doc design.

Scenario 2

If the page https://docs.github.com/en is saved as HTML, the script will generate a sphinx theme for part of the themata collection, this is exclusive to the themata collection only.

Features

  • Can generate a random name from the page or title, between 5 - 6 letters long
  • Generates completely usable python sphinx theme
  • Allows customizing the layout properties automatically base on the themata framework and APIs.
  • Allows customizing the CSS and JS to auto-generate theme_options
  • Can generate a showcase like documentation page for the generated theme base on themata API
  • Scenario 1 functional
  • Scenario 2 functional
  • Add a label or detail on the page (a standalone likely) that shows it generated by themata
  • Warn user if the HTML page already has a theme in themata
  • Build a Tkinter GUI to perform the operations
    • Download the webpage
    • Set the theme options using themata API and frameworks for
      • layout
      • JS
      • CSS
    • all the main features operations above

TODO

  • Rewrite all existing themata themes to be auto-generated by the script without breaking backward compatibility
  • Generate the new themes from the issue Add new themes #32 with the script
  • Record the page that a theme is derived from in themata for warning
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

No branches or pull requests

1 participant