Giter Club home page Giter Club logo

arc42-with-sphinx's Introduction

Software Architecture with arc42 and Sphinx

This is a template to documents software architectures using arc42 in reStructuredText (rst). Furthermore, this repository contains all bits to compile the documentation using Sphinx.

Usage

  1. Clone this repository and replace all occurrences of {PROJECT} with the actual project name:
    find . -type f -exec sed -i 's/{PROJECT}/Concrete Project Name/g' {} +
        
  2. In source/conf.py replace {AUTHOR} with your name.
  3. Also remove the .github/ directory.

Development

See the Development section in the README at the root of this repository.

arc42-with-sphinx's People

Contributors

thomasbach-dev avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.