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

Switch to pdoc #856

Merged
merged 3 commits into from
Dec 23, 2021
Merged

Conversation

davfsa
Copy link
Member

@davfsa davfsa commented Oct 19, 2021

Summary

Switch to pdoc with new theme style and better mobile compatibility

This branch is not 100% functional to be merged into master, as it relies a bit on having multiple documentation versions. The idea is to have this merged into a separate branch and then it can be worked on from there, as this is already really big

Related issues

Solves all points in #808

Screenshots

Desktop

image
image

Mobile

image
Screen Shot 2021-10-19 at 22 07 28
Screen Shot 2021-10-19 at 22 07 51

@davfsa davfsa added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 19, 2021
@davfsa davfsa added this to the 2.0.0 milestone Oct 19, 2021
@davfsa davfsa changed the base branch from master to feature/docs-v2 October 19, 2021 19:11
@davfsa davfsa added skip-fragment-check Skip fragment checks for this PR as it doesnt need one and removed skip-fragment-check Skip fragment checks for this PR as it doesnt need one labels Oct 19, 2021
@davfsa davfsa changed the base branch from feature/docs-v2 to master October 19, 2021 19:40
@davfsa davfsa changed the base branch from master to feature/docs-v2 October 19, 2021 19:40
@davfsa davfsa changed the base branch from feature/docs-v2 to master October 19, 2021 19:41
@davfsa davfsa added skip-fragment-check Skip fragment checks for this PR as it doesnt need one and removed skip-fragment-check Skip fragment checks for this PR as it doesnt need one labels Oct 19, 2021
@davfsa davfsa changed the base branch from master to feature/docs-v2 October 19, 2021 19:41
@davfsa
Copy link
Member Author

davfsa commented Oct 19, 2021

Fixed failing workflows and added some screenshots to the initial comment, in case anybody is interested :)

@davfsa davfsa removed the skip-fragment-check Skip fragment checks for this PR as it doesnt need one label Oct 19, 2021
@davfsa davfsa force-pushed the task/pdoc-switch-start branch 2 times, most recently from 9dc09ac to 693c685 Compare October 20, 2021 17:18
docs/patched_pdoc.py Outdated Show resolved Hide resolved
@davfsa davfsa force-pushed the task/pdoc-switch-start branch 4 times, most recently from f279d8f to c923156 Compare October 26, 2021 18:36
@davfsa
Copy link
Member Author

davfsa commented Oct 27, 2021

@FasterSpeeding mind if i merge this to the feature branch so I can finish off the multiple version documentation?

docs/module.html.jinja2 Outdated Show resolved Hide resolved
hikari/api/event_manager.py Show resolved Hide resolved
hikari/api/interaction_server.py Show resolved Hide resolved
hikari/api/cache.py Show resolved Hide resolved
hikari/api/cache.py Outdated Show resolved Hide resolved
hikari/api/entity_factory.py Show resolved Hide resolved
hikari/emojis.py Outdated Show resolved Hide resolved
hikari/impl/bot.py Show resolved Hide resolved
hikari/impl/bot.py Show resolved Hide resolved
hikari/impl/bot.py Show resolved Hide resolved
hikari/impl/bot.py Show resolved Hide resolved
@davfsa davfsa self-assigned this Nov 9, 2021
@davfsa davfsa force-pushed the task/pdoc-switch-start branch 2 times, most recently from c1729af to 26a8546 Compare December 22, 2021 16:56
@davfsa
Copy link
Member Author

davfsa commented Dec 23, 2021

Finally done with all points from #808, so it can be considered closed and solved for the most part. Will be actually closed once this is merged into master :)

@davfsa davfsa merged commit 692f2d2 into hikari-py:feature/docs-v2 Dec 23, 2021
@davfsa davfsa mentioned this pull request Dec 23, 2021
5 tasks
davfsa added a commit that referenced this pull request Feb 6, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit to davfsa/hikari that referenced this pull request Feb 6, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Feb 12, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Feb 12, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Feb 14, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Feb 14, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Feb 19, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Mar 1, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Mar 7, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Mar 25, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Mar 25, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Mar 26, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Mar 26, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Mar 26, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Mar 30, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Mar 31, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
davfsa added a commit that referenced this pull request Apr 5, 2022
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants