https://github.com/mailsac/mailsac-examples

Docs and Guides for Mailsac, the Friendliest Disposable Email API
https://github.com/mailsac/mailsac-examples

Last synced: 5 months ago
JSON representation

Docs and Guides for Mailsac, the Friendliest Disposable Email API

• Host: GitHub
• URL: https://github.com/mailsac/mailsac-examples
• Owner: mailsac
• License: mit
• Created: 2018-03-30T21:53:44.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2025-07-15T00:15:47.000Z (11 months ago)
• Last Synced: 2025-07-15T04:43:22.207Z (11 months ago)
• Language: Python
• Homepage: https://docs.mailsac.com
• Size: 11.8 MB
• Stars: 16
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Mailsac-Examples

This repository is the documentation for Mailsac. It includes examples, service

information, privacy policy, and terms of services.

## Build Instructions

These documents are published to docs.mailsac.com, they can be built locally

for testing purposes.

1. Clone this repo

   `git clone https://github.com/mailsac/mailsac-examples.git`

2. Change directories to the cloned repo

   `cd mailsac-examples`

3. Setup virtual environment (option but helps isolate python modules)

   `python3 -m venv venv`

   `source venv/bin/activate`

4. Install sphinx

   `pip3 install -r requirements.txt`

5. Run build script

   `make html`

6. Build results can be found in `_build/html/`

7. Optional - run a server to view the html output.

    `npm install http-server -g`

    `http-server _build/html`

8. Alternatively the reStructuredText Visual Studio Code extension can be used for live previews

# License

Copyright © 2019-2023 by Forking Software LLC

MIT License

See the LICENSE file in this repository.