codacy-badger/apydox

apydox is a happy, light-weight API documentation portal for your team

apydox

apydox is a happy, light-weight API documentation portal for your team

Installation

To install the portal you will need to deploy and host your own instance of the software.

The documentation for deploying your very own instance of apydox can be found here.

The portal has two parts, an api and a web ui, the following are the sections on how to deploy these two parts of the application for different targets:

• Deploying the api as serverless functions and an API gateway
• Deploying the api as a docker container
• Deploying the web ui to S3
• Deploying the web ui as a docker container

Documentation

We have a section on using the portal to get your team up to speed with what you can and can't do (yet) with the portal here:

Using the portal

Contributing

Contribution is essential to the growth and adoption of apydox as a cost-effective portal for API documentation for multiple APIs. apydox is an open source project and will therefore thrive of contributions from the wider community whether they be bug fixes, improvements or even new features.

Contributing Guidelines

Read our contribution guidelines and a piece on how to get your environment set up for development.

Good First Issues

At times it can be hard to know how to start contributing to an open source project. We have a collection of good first issues for relatively small bug fixes and minor improvements to get you on your way.

License

apydox has an Apache 2 license