Split documentation into multiple pages. #722
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
junkmd
added a commit
to junkmd/pywinauto
that referenced
this pull request
Dec 26, 2024
junkmd
added a commit
that referenced
this pull request
Dec 26, 2024
junkmd
force-pushed
the
rtd_split_revive_update
branch
from
40ca6e3 to
1ba03ed
Compare
junkmd
added a commit
that referenced
this pull request
Dec 26, 2024
junkmd
force-pushed
the
rtd_split_revive_update
branch
from
1ba03ed to
a83401d
Compare
junkmd
added a commit
that referenced
this pull request
Dec 26, 2024
junkmd
force-pushed
the
rtd_split_revive_update
branch
from
a83401d to
d9accfa
Compare
junkmd
added a commit
that referenced
this pull request
Dec 26, 2024
Run `git revert 3c916f6` and cherry-pick `com_interfaces.txt`.
…sts in `com_interfaces.rst`.
junkmd
force-pushed
the
rtd_split_revive_update
branch
from
d9accfa to
d86b714
Compare
junkmd
added a commit
to junkmd/pywinauto
that referenced
this pull request
Dec 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See also #230.
The documentation's top page (
index.rst) of the pythonhosted era primarily focused on client-side explanations.While it’s true that client-side use cases represent the majority of this project’s usage, an overly large top page makes it difficult to grasp all the features the project provides.
In fact, the link to the server-side documentation had been buried and was hard to find.
To address this, I minimized the content on the top page and organized links.
Additionally, I noticed that the documentation once included a file called
com_interfaces.txt(version 0.3.2 and version 0.4), which provided explanations aboutIUnknownand metaclasses.Since the behavior of these components has largely remained unchanged, I decided to bring this information back, updating older styles as necessary.
There are still needs to modernize individual sections.
If the community could help with improvements, it is great.