Giter VIP home page Giter VIP logo

build-me-the-docs-please's Introduction

Project Management Tools

This is a public git repository for documentation about various project management tools and related software. It basically contains information for users, tips, tricks and small how-to-do descriptions.

How to use the repository:

  1. Create an account in Github.

  2. Fork the master repository.

  3. Install git on your computer.

  4. Create a local repository (by cloning your fork).

  5. Create a branch to store your work (e.g. myChangesToRequirements).

  6. Make changes, local commits, etc..

  7. Commit to your fork.

  8. When you want your changes to be reviewed and integrated into the master, send a pull request.

  9. Your changes will be reviewed and merged into the main branch.

  10. Update your repositories to avoid conflicts.

Please read /docs/build/html/On_VersionControl/UsingGit.rst

Documents are stored in:

Textual information is stored in reStructured Text files (rst files). Please read /docs/build/html/On_Documentation/OnReStructuredText.rst

Images are stored in png format.

The documents are stored in:

  • the /docs/source/ folders.

Please do not change:

  • the .gitignore file
  • the /docs/makefile and the mosy/docs/make.bat file (required by Sphinx)
  • the /docs/source/conf.py file (required by Sphinx)
  • the /docs/_static directory
  • the /docs/_templates directory
  • the /docs/_themes directory
  • the /utils directory content

Each subdirectory (may) contain:

  • an index.rst file with the partial table of contents of the directory

  • a Z_GenericLinks.rst file with all the hyperlinks required by the documents in the directory. An ..include:: directive is used to include the file at the end of ther refereing documents (after the .. links-placeholder.

  • a Z_References.rst file containing bibliographic references. Later on, this files will be consolidated into a bibtex file, and all citations will be changed accordingly.

  • an img directory containing images used in the documents.

Documents are built with Sphinx.

build-me-the-docs-please's People

Contributors

lextm avatar massimiliano-della-rovere avatar percursoaleatorio avatar

Watchers

 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.