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

chore: add basic doc gen #638

Merged
merged 1 commit into from
Jul 7, 2023

Conversation

boneskull
Copy link
Contributor

This adds basic documentation generation via appium-docs.

Future work should include:

  • Add the human-written docs to the nav in mkdocs.yml
  • More descriptions of commands (in docstrings)
  • Some sort of landing page or otherwise fix the broken links in the generated README.md
  • Add a workflow to build and/or publish docs

To build & serve:

npm exec appium-docs build -- --serve

@boneskull
Copy link
Contributor Author

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@boneskull boneskull self-assigned this Jul 5, 2023
@boneskull
Copy link
Contributor Author

I'm unsure if we need to add ./node_modules/appium-android-driver to the entryPoints in typedoc.json. If we do need something there, we will need to add tsconfig.json to its files prop of package.json. Someone may want to take a look and see if there are any commands missing from the doc output that are only defined in appium-android-driver.

Note that appium-android-driver has no executeMethodMap and no such commands are inherited this way.

@boneskull boneskull force-pushed the boneskull/execute-methods branch from a2ea0cc to 1154898 Compare July 5, 2023 21:19
@boneskull boneskull force-pushed the boneskull/docutils-setup branch from f58a974 to ba9d0e3 Compare July 5, 2023 21:19
@boneskull boneskull force-pushed the boneskull/execute-methods branch from 1154898 to 4e81123 Compare July 6, 2023 18:54
@boneskull boneskull force-pushed the boneskull/docutils-setup branch from ba9d0e3 to cd80f16 Compare July 6, 2023 18:54
@boneskull boneskull merged commit edc48e5 into boneskull/execute-methods Jul 7, 2023
@boneskull boneskull deleted the boneskull/docutils-setup branch July 7, 2023 21:20
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

Successfully merging this pull request may close these issues.

3 participants