The Wayback Machine - https://web.archive.org/web/20200921033116/https://github.com/jeshan/botodocs
Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

botodocs: a (hopefully) better boto3 doc site

Visit https://botodocs.com

Why

I thought that the official docs has a lot of room to improve, so I built a "better" site in the meantime.

Features

  • lots of caching
  • better navigation
  • fast to load
  • shorter pages

Note to forkers:

This project uses docsify to convert the markdown files into a simple static website.

  • npm i docsify-cli -g
  • run pipenv run python main.py to generate the pages and serve a website (note that it calls docsify serve docs behind the scenes)
  • Open browser at http://localhost:3000
  • Edits to static files will be reloaded live. Otherwise rerun main.py for dynamic pages.

Deploying on AWS

Uses the AWS CDK. See lib/pipeline-construct.js for details on the deployment pipeline.

  • npm i -g aws-cdk
  • cdk deploy

This is what the CDK will deploy:

Image automatically generated with cfnbuddy

Legal

Released under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)

https://creativecommons.org/licenses/by-nc-sa/4.0/

Project is based on boto3. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed Apache Licence 2.0. See file original-LICENCE for details

About

Simple, navigable and fast documentation site for boto3 (unofficial)

Topics

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.