kaliiiiiiiiii / Selenium-Driverless

undetected Selenium without usage of chromedriver
https://kaliiiiiiiiii.github.io/Selenium-Driverless/
Other
412 stars 52 forks source link

[TODO] serve docs #160

Closed milahu closed 5 months ago

milahu commented 5 months ago

github pages seems to be active but i dont see the result at kaliiiiiiiiii.github.io/Selenium-Driverless where is it...?

the link should be in the "about" section of github.com/kaliiiiiiiiii/Selenium-Driverless

also, currently, the github pages action runs jekyll but docs/ looks like static html files, generated by sphinx

pypi.org/project/selenium-driverless has the same url for homepage, docs, source

kaliiiiiiiiii commented 5 months ago

Yeah I at first tried to serve the spinx stuff over github pages, all path at _static/* didn't resolve correctly tho. Assume it's because of the _.

Maybe using readthedocs is an option? (uses sphinx to my knowledge as well).

Feel free to contribute on that//add a PR. At this point, I didn't really get further.

Also, I'm not sure about the member ordering at https://github.com/kaliiiiiiiiii/Selenium-Driverless/blob/5f56548a3c2bade6d42edda7bcc8085fcf8afff0/docs_source/classes/Chrome.rst?plain=1#L6-L12.

Maybe there's some way to provide a hint on that already within the class?

milahu commented 5 months ago

I at first tried to serve the spinx stuff over github pages

https://duckduckgo.com/?q=sphinx+docs+%22github+pages%22 ...?

all path at _static/* didn't resolve correctly

a common issue with SSG and github pages are absolute links which drop the root path /Selenium-Driverless

kaliiiiiiiiii commented 5 months ago

I at first tried to serve the spinx stuff over github pages

https://duckduckgo.com/?q=sphinx+docs+%22github+pages%22 ...?

haha fair enough, by bad😂

https://stackoverflow.com/questions/62626125/github-pages-with-sphinx-generated-documentation-not-displaying-html-correctly

kaliiiiiiiiii commented 5 months ago

Resolved by https://github.com/kaliiiiiiiiii/Selenium-Driverless/commit/36c7e05452317f31e4051356e489875216b011a1

See https://kaliiiiiiiiii.github.io/Selenium-Driverless/

Note: Documentation isn't complete yet at all:)