Skip to content

Conversation

@andyk
Copy link
Contributor

@andyk andyk commented Mar 19, 2022

Fixes #289 and #337

This updates the API docs and also updates the build_docs.py script to auto-generate the API docs with less manual work required to curate stub sphinx ReStructuredText files.

This also fixes some syntax bugs in the example code in the REPL Quickstart in the documentation.

@andyk andyk marked this pull request as ready for review March 22, 2022 18:24
@andyk andyk requested a review from nickjalbert March 22, 2022 18:32
@andyk
Copy link
Contributor Author

andyk commented Mar 22, 2022

@nickjalbert I think this and #326 are ready for review!

@andyk andyk changed the title WIP: Break pcs out into separate dir (i.e., module) WIP: Break pcs out into separate dir and fix some broken example_agents Mar 22, 2022
Copy link
Contributor

@nickjalbert nickjalbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM except it appears python scripts/build_docs.py is broken (it's still trying to import agentos/version.py instead of pcs/version.py). We'll also have to update the autodoc stubs in documentation/api to point to the new pcs location.

Not sure if that's what you meant by the docs not being updated, but we could port that in a different PR if you want to merge this one now.

@andyk
Copy link
Contributor Author

andyk commented Mar 24, 2022

Ok @nickjalbert I think I've addressed all of your feedback and updated the main text of this PR to reflect the updates. If tests are green I think we are in good shape, though might be nice if you try out the newly updated scripts/build_docs.py file.

@andyk andyk changed the title WIP: Break pcs out into separate dir and fix some broken example_agents Break pcs out into separate dir and fix some broken example_agents Mar 24, 2022
@andyk
Copy link
Contributor Author

andyk commented Mar 24, 2022

Actually I just noticed this PR still doesn't add readme files to all of the example agents, which is one of the things you suggested.

@nickjalbert
Copy link
Contributor

Build is green! Merging! Thanks for doing this. :)

@nickjalbert nickjalbert merged commit 9336c0d into agentos-project:master Mar 24, 2022
andyk added a commit to andyk/agentos that referenced this pull request Mar 25, 2022
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.

Move PCS API into a separate top level pcs module

2 participants