| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <title>How to make your project PyCommunity-compatible</title> |
|---|
| 4 | <style type="text/css" media="all"> |
|---|
| 5 | @import "../pycommunity.css"; |
|---|
| 6 | </style> |
|---|
| 7 | <script language="javascript" type="text/javascript" |
|---|
| 8 | src="../pycommunity.js" ></script> |
|---|
| 9 | </head> |
|---|
| 10 | <body> |
|---|
| 11 | <div class="backlink"> |
|---|
| 12 | <a href="../tutorials.html"> |
|---|
| 13 | <img src="../media/tutorial.png"/> |
|---|
| 14 | Tutorial list |
|---|
| 15 | </a> |
|---|
| 16 | <a href="../index.html"> |
|---|
| 17 | <img src="../media/home.png"/> |
|---|
| 18 | Main page |
|---|
| 19 | </a> |
|---|
| 20 | </div> |
|---|
| 21 | <div class="content"> |
|---|
| 22 | <div class="document" id="how-to-make-your-project-pycommunity-compatible"> |
|---|
| 23 | <h1 class="title">How to make your project PyCommunity-compatible</h1> |
|---|
| 24 | <p>There are a few mandatory files PyCommunity uses to generate a website:</p> |
|---|
| 25 | <ul class="simple"> |
|---|
| 26 | <li>a <cite>glossary.txt</cite> file. Learn how to write a good glossary in the |
|---|
| 27 | <a title='glossary_recipe' alt='glossary_recipe' href='../recipes/glossary_recipe.html'>Glossary Recipe</a> |
|---|
| 28 | <img src="../media/expand.png" onclick="toggleElement('expandable-glossary_recipe')"/> |
|---|
| 29 | <div id="expandable-glossary_recipe" class="expandable" style="display:none"> |
|---|
| 30 | <b>Soon</b> |
|---|
| 31 | <div> |
|---|
| 32 | </li> |
|---|
| 33 | <li>a global <cite>README.txt</cite> file, that describes the project. |
|---|
| 34 | <a title='main_readme_recipe' alt='main_readme_recipe' href='../recipes/main_readme_recipe.html'>main_readme_recipe</a> |
|---|
| 35 | <img src="../media/expand.png" onclick="toggleElement('expandable-main_readme_recipe')"/> |
|---|
| 36 | <div id="expandable-main_readme_recipe" class="expandable" style="display:none"> |
|---|
| 37 | <b>Soon</b> |
|---|
| 38 | <div> |
|---|
| 39 | gives a few tips about it</li> |
|---|
| 40 | <li>a <cite>package.txt</cite> file, that is used in the package list page. This file contains a introductary text that describes the packages.</li> |
|---|
| 41 | </ul> |
|---|
| 42 | <p>All of this files are pointed in <cite>pycommunity.conf</cite> and the |
|---|
| 43 | website is generated with this simple command. The simplest way to start is |
|---|
| 44 | to copy the original <cite>pycommunity.conf</cite> to a specific project conf file, then |
|---|
| 45 | to call it:</p> |
|---|
| 46 | <pre class="literal-block"> |
|---|
| 47 | pycommunity /path/to/project.conf |
|---|
| 48 | </pre> |
|---|
| 49 | </div> |
|---|
| 50 | </div> |
|---|
| 51 | <div class="backlink"> |
|---|
| 52 | <a href="../tutorials.html"> |
|---|
| 53 | <img src="../media/tutorial.png"/> |
|---|
| 54 | Tutorial list |
|---|
| 55 | </a> |
|---|
| 56 | <a href="../index.html"> |
|---|
| 57 | <img src="../media/home.png"/> |
|---|
| 58 | Main page |
|---|
| 59 | </a> |
|---|
| 60 | </div> |
|---|
| 61 | |
|---|
| 62 | </body> |
|---|
| 63 | </html> |
|---|
