Skip to main content

Documentation drives developing.

Project description

# XDocs

Documentation drives developing.

## Getting Started


1. `pip install xdocs`
2. `xdocs new tutorial`
3. `cd tutorial`
4. `xdocs run`

## Feature Support

1. translate yml documentation to web pages
2. generate static web pages
3. simulation http client
4. generate request code for many program languages
5. generate test code
6. mock data server
8. web pages hot reload

## TODO

1. design document structure
2. design the rule of writing documentation
3. translate yml file to html
4. generate mock data server
5. maybe add the authentication and permissions into this project in the future

## Final Thoughts

1. documentation driven develop
1. separate server and client
2. improve api quality
3. improve speed of developing
4. shorten the time of deliver

## License

[MIT](LICENSE).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xdocs-0.2.0.tar.gz (45.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page