| Server IP : 82.148.16.210 / Your IP : 216.73.216.19 Web Server : nginx/1.29.5 System : Linux mail.sarafai.ru 6.1.0-43-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.162-1 (2026-02-08) x86_64 User : root ( 0) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /proc/746/root/usr/share/doc/python3-docutils/docs/dev/ |
Upload File : |
<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> <title>Docutils Web Site</title> <meta name="author" content="David Goodger; open to all Docutils developers" /> <meta name="date" content="2022-04-02" /> <meta name="copyright" content="This document has been placed in the public domain." /> <link rel="stylesheet" href="../../css/html4css1.css" type="text/css" /> </head> <body> <div class="header"> <a class="reference external" href="https://docutils.sourceforge.io">Docutils</a> | <a class="reference external" href="../index.html">Overview</a> | <a class="reference external" href="../index.html#project-fundamentals">About</a> | <a class="reference external" href="../index.html#user">Users</a> | <a class="reference external" href="../index.html#ref">Reference</a> | <a class="reference external" href="../index.html#howto">Developers</a> <hr class="header"/> </div> <div class="document" id="docutils-web-site"> <h1 class="title">Docutils Web Site</h1> <table class="docinfo" frame="void" rules="none"> <col class="docinfo-name" /> <col class="docinfo-content" /> <tbody valign="top"> <tr><th class="docinfo-name">Author:</th> <td>David Goodger; open to all Docutils developers</td></tr> <tr><th class="docinfo-name">Contact:</th> <td><a class="first last reference external" href="mailto:docutils-develop@lists.sourceforge.net">docutils-develop@lists.sourceforge.net</a></td></tr> <tr><th class="docinfo-name">Date:</th> <td>2022-04-02</td></tr> <tr><th class="docinfo-name">Revision:</th> <td>9051</td></tr> <tr><th class="docinfo-name">Copyright:</th> <td>This document has been placed in the public domain.</td></tr> </tbody> </table> <!-- Minimal menu bar for inclusion in documentation sources in ``docutils/docs/*/`` sub-diretories. Attention: this is not a standalone document. --> <p>The Docutils web site, <<a class="reference external" href="https://docutils.sourceforge.io/">https://docutils.sourceforge.io/</a>>, is maintained by the <tt class="docutils literal"><span class="pre">docutils-update.local</span></tt> script, run by project maintainers on their local machines. The script will process any .txt file which is newer than the corresponding .html file in the local copy of the project's web directory and upload the changes to the web site at SourceForge.</p> <!-- .. old instructions, for cron job: The Docutils web site, <https://docutils.sourceforge.io/>, is maintained automatically by the ``docutils-update`` script, run as an hourly cron job on shell.berlios.de (by user "wiemann"). The script will process any .txt file which is newer than the corresponding .html file in the project's web directory on shell.berlios.de (``/home/groups/docutils/htdocs/aux/htdocs/``) and upload the changes to the web site at SourceForge. --> <p>Please <strong>do not</strong> add any generated .html files to the Docutils repository. They will be generated automatically after a one-time setup (<a class="reference internal" href="#adding-txt-files">described below</a>).</p> <p>The <a class="reference external" href="https://docutils.sourceforge.io/sandbox/infrastructure/docutils-update.local">docutils-update.local</a> script is located at <tt class="docutils literal"><span class="pre">sandbox/infrastructure/docutils-update.local</span></tt>.</p> <p>If you want to share files via the web, you can upload them using the <a class="reference external" href="https://docutils.sourceforge.io/sandbox/infrastructure/uploaddocutils.sh">uploaddocutils.sh</a> script (<tt class="docutils literal">sandbox/infrastructure/uploaddocutils.sh</tt>).</p> <div class="section" id="setting-up"> <h1>Setting Up</h1> <p>(TBA)</p> <div class="admonition hint"> <p class="first admonition-title">Hint</p> <p>Anyone with checkin privileges can be a web-site maintainer. You need to set up the directories for a local website build.</p> <p class="last">The procedure for that was on the docutils-devel list a while ago.</p> </div> </div> <div class="section" id="adding-txt-files"> <h1>Adding .txt Files</h1> <div class="section" id="user-contributor"> <h2>User/Contributor</h2> <p>When adding a new .txt file that should be converted to HTML:</p> <ol class="arabic simple"> <li>Edit sandbox/infrastructure/htmlfiles.lst, and add the .html file corresponding to the new .txt file (please keep the sorted order).</li> <li>Commit the edited version to the SVN repository.</li> </ol> </div> <div class="section" id="maintainer"> <h2>Maintainer</h2> <ol class="arabic"> <li><p class="first">If there are new directories in the SVN, allow the update script to run once to create the directories in the filesystem before preparing for HTML processing.</p> </li> <li><p class="first">Run the sandbox/infrastructure/update-htmlfiles shell script to generate .html files:</p> <pre class="literal-block"> cd <DOCUTILS-ROOT>/docutils/ sandbox/infrastructure/update-htmlfiles \ sandbox/infrastructure/htmlfiles.lst </pre> <p>(Maybe this should become part of docutils-update.local.)</p> </li> </ol> </div> </div> <div class="section" id="removing-files-directories"> <h1>Removing Files & Directories</h1> <ol class="arabic simple"> <li>Remove from SVN</li> <li>Remove to-be-generated HTML files from <tt class="docutils literal">sandbox/infrastructure/htmlfiles.lst</tt>.</li> <li>Removing files and directories from SVN will not trigger their removal from the web site. Files and directories must be manually removed from sourceforge.net (under <tt class="docutils literal"><span class="pre">/home/project-web/docutils/htdocs/</span></tt>).</li> </ol> <!-- Local Variables: mode: indented-text indent-tabs-mode: nil sentence-end-double-space: t fill-column: 70 End: --> </div> </div> </body> </html>