CINXE.COM
Docutils: Documentation Utilities / Code / [r9989] /trunk/docutils
<!DOCTYPE html> <!-- Server: sfs-forge-4 --> <html lang="en" class="no-js"> <head> <meta content="text/html; charset=UTF-8" http-equiv="content-type"/> <title> Docutils: Documentation Utilities / Code / [r9989] /trunk/docutils </title> <meta name="viewport" content="width=1100"> <link rel="icon" sizes="180x180" href="https://a.fsdn.com/con/img/sandiego/logo-180x180.png" type="image/png"> <link rel="icon" sizes="any" href="https://a.fsdn.com/con/img/sandiego/svg/originals/sf-icon-orange-no_sf.svg" type="image/svg+xml"> <link rel="apple-touch-icon" sizes="180x180" href="https://a.fsdn.com/con/img/sandiego/logo-180x180.png"> <link rel="mask-icon" href="https://a.fsdn.com/con/img/sandiego/svg/originals/sf-icon-orange-no_sf.svg" color="#FF6600"> <link rel="stylesheet" href="https://a.fsdn.com/con/css/lato.css?"> <script> if (!window.SF) { window.SF = {}; } SF.sandiego = false; SF.sandiego_chrome = true; SF.cdn = "https://a.fsdn.com/con"; SF.fpid = '170e610b-fb59-4fa8-8e28-f9861c1edc4f'; SF.billboard_route = '/software/product/$slug/'; </script> <!-- ew:head_css --> <link rel="stylesheet" type="text/css" href="https://a.fsdn.com/allura/nf/1732305734/_ew_/_slim/css?href=allura%2Fcss%2Fforge%2Fhilite.css%3Ballura%2Fcss%2Fforge%2Ftooltipster.css" > <link rel="stylesheet" type="text/css" href="https://a.fsdn.com/allura/nf/1732305734/_ew_/allura/css/font-awesome.min.css" > <link rel="stylesheet" type="text/css" href="https://a.fsdn.com/allura/nf/1732305734/_ew_/theme/sftheme/css/forge.css" > <!-- /ew:head_css --> <!-- ew:head_js --> <script type="text/javascript" src="https://a.fsdn.com/allura/nf/1732305734/_ew_/_slim/js?href=allura%2Fjs%2Fjquery-3.6.0.min.js%3Ballura%2Fjs%2Fjquery.cookie-1.4.1.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fcmp2.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fshared_head.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Ftypescript%2Fcompliance.js"></script> <!-- /ew:head_js --> <style type="text/css"> /* make URL & Project custom fields in support tickets not get hidden as much */ .project-forge.mountpoint-site-support .view_holder .grid-4:nth-child(5), .project-forge.mountpoint-site-support .view_holder .grid-4:nth-child(6) { overflow: visible; font-size: 22px; width: 340px; line-height: 1; margin-bottom: 5px; } .project-forge.mountpoint-site-support .view_holder .grid-4:nth-child(5) label, .project-forge.mountpoint-site-support .view_holder .grid-4:nth-child(6) label { font-size: 14px; } </style> <link rel="alternate" type="application/rss+xml" title="RSS" href="/p/docutils/code/feed.rss"/> <link rel="alternate" type="application/atom+xml" title="Atom" href="/p/docutils/code/feed.atom"/> <style type="text/css"> #access_urls .btn-set { min-width: 14em; } </style> <style> form.tarball { display: inline; margin: 0; padding: 0; } form.tarball button { background: none; border: 0; box-shadow: none; text-shadow: none; color: #fff; font-weight: normal;; padding: 0; margin-bottom: 0; font-size: 12px; line-height: 36px; } form.tarball button:hover { border: 0 !important; } </style> <style>.XHMKwDvsOvWsKiwrDikYnYcKzBKbMKowZMwog { display: none }</style> <link rel="canonical" href="https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/" /> <script> function initPiwik(){ var _paq = window._paq = window._paq || []; _paq.push(['trackPageView', document.title, { dimension1: 'docutils', dimension2: 'svn' }]); _paq.push(['enableLinkTracking']); (function() { var u="//analytics.slashdotmedia.com/"; _paq.push(['setTrackerUrl', u+'sf.php']); _paq.push(['setSiteId', 39]); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'sf.js'; s.parentNode.insertBefore(g,s); })(); } bizx.cmp.ifConsent({ purposes: ['storage', 'measurement'], vendors: 'sdm'}, initPiwik); </script> <!-- Hubspot tracking --> </head> <body class=" body_class sandiego_chrome legacy_chrome l-allow-natural-width " id="forge"> <!-- ew:body_top_js --> <!-- /ew:body_top_js --> <div class="off-canvas position-right" id="offCanvas" data-off-canvas> <!-- Menu --> <ul class="header-nav-menulist"> <li class="highlight search"> <form method="get" action="/directory/" class="m-search-form"> <input type="text" placeholder="Search for software or solutions" autocomplete="off" name="q" > <label> <input type="submit" class="bt" value=""> <svg data-name="search" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1216 832q0-185-131.5-316.5t-316.5-131.5-316.5 131.5-131.5 316.5 131.5 316.5 316.5 131.5 316.5-131.5 131.5-316.5zm512 832q0 52-38 90t-90 38q-54 0-90-38l-343-342q-179 124-399 124-143 0-273.5-55.5t-225-150-150-225-55.5-273.5 55.5-273.5 150-225 225-150 273.5-55.5 273.5 55.5 225 150 150 225 55.5 273.5q0 220-124 399l343 343q37 37 37 90z"/></svg> </label> </form> </li> <li class="highlight"><a href="/auth/">Join/Login</a></li> <li><a href="/directory/">Open Source Software</a></li> <li><a href="/software/">Business Software</a></li> <li><a href="/software/vendors/" title="For Vendors">For Vendors</a></li> <li><a href="/blog/" title="Blog">Blog</a></li> <li><a href="/about">About</a></li> <li><a id="header-nav-more" data-toggle="header-nav-more header-nav-more-content" data-toggler=".toggled">More</a></li> <li> <ul id="header-nav-more-content" class="toggled" data-toggler=".toggled"> <li><a href="/articles/">Articles</a></li> <li><a href="/create">Create</a></li> <li><a href="https://sourceforge.net/articles/category/sourceforge-podcast/">SourceForge Podcast</a></li> <li><a href="https://sourceforge.net/p/forge/documentation/Docs%20Home/">Site Documentation</a></li> <li><a href="/user/newsletters">Subscribe to our Newsletter</a></li> <li><a href="/support">Support Request</a></li> </ul> </li> </ul> </div> <div class="off-canvas-content" data-off-canvas-content> <script> SF.linkout_icon = '<svg data-name="sf-linkout-icon" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 300 300" style="enable-background:new 0 0 300 300;" xml:space="preserve"><polygon class="st0" points="243.2,243.2 56.8,243.2 56.8,56.8 123,56.8 123,9 9,9 9,291 291,291 291,179.4 243.2,179 "/><polygon class="st0" points="128.5,213 155,186.5 176,165.5 206.7,196.3 235.5,132.5 248.9,102.6 290.6,9.8 291,9 290.6,9.2 197.4,51.1 169.1,63.8 103.7,93.3 137,126.5 115.9,147.5 89.5,174 "/></svg>'; </script> <div class="l-header-nav sandiego"> <section class="sandiego l-header-nav-top show-for-large"> <div class="row"> <a href="/" title="Home" class="sf-logo"> <img src="https://a.fsdn.com/con/images/sandiego/sf-logo-full.svg" alt="SourceForge logo" class="sf-logo-full"/> </a> <nav class="links"> <a href="/user/newsletters" title="Subscribe to our newsletter"><span class="newsletter-icon"> <svg data-name="mmSF_11mail" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 42 42" enable-background="new 0 0 42 42" xml:space="preserve"><path fill="#FFFFFF" d="M0,6v30h42V6H0z M24.2,21.2c-0.8,0.8-2.3,2-3.2,2c-0.9,0-2.4-1.2-3.2-2L5.8,9.7h30.3L24.2,21.2z M13.7,21l-9.9,9.4V11.6L13.7,21z M15.7,23L15.7,23c0.5,0.5,2.9,2.9,5.3,2.9c2.4,0,4.8-2.4,5.2-2.8l0.1-0.1l9.8,9.4H5.8L15.7,23z M28.3,21l9.9-9.5v18.9L28.3,21z"/></svg></span></a> <a href="/software/vendors/" title="For Vendors">For Vendors</a> <a href="/support" title="Help">Help</a> <a href="/create/" title="Create">Create</a> <a href="/user/registration" title="Join" >Join</a> <a href="/auth/" title="Login">Login</a> </nav> </div> </section> <section class="sandiego l-header-nav-top hide-for-large"> <div class="row"> <a href="/" title="Home" class="sf-logo"> <img src="https://a.fsdn.com/con/images/sandiego/sf-logo-full.svg" alt="SourceForge logo" class="sf-logo-full"/> </a> <div class="title-bar-right"> <button type="button" aria-label="Toggle Main Menu" class="menu-icon" data-toggle="offCanvas"></button> </div> </div> </section> <section class="sandiego l-header-nav-bottom"> <nav class="row"> <a href="/" title="Home" class="sf-logo"> <img src="https://a.fsdn.com/con/images/sandiego/sf-logo-full.svg" alt="SourceForge logo" class="sf-logo-full"/> </a> <div class="links"> <div class="nav-dropdown"> <a href="/directory/" title="Browse">Open Source Software</a> </div> <div class="nav-dropdown"> <a href="/software/">Business Software</a> </div> <div class="nav-dropdown"> <a href="https://sourceforge.net/articles/category/sourceforge-podcast/">SourceForge Podcast</a> </div> <div class="nav-dropdown"> <a>Resources</a> <ul class="nav-dropdown-menu"> <li><a href="/articles/">Articles</a></li> <li><a href="/software/case-studies/">Case Studies</a></li> <li><a href="/blog/">Blog</a></li> </ul> </div> <div class="dev-menu-when-stuck"> Menu <ul class="dev-menu-dropdown header-nav-menulist"> <li><a href="/support">Help</a></li> <li><a href="/create">Create</a></li> <li><a href="/user/registration/" title="Join" >Join</a></li> <li><a href="/auth/" title="Login">Login</a></li> </ul> </div> <div class="search-toggle-when-stuck"> <a class="search-toggle"> <svg data-name="search" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1216 832q0-185-131.5-316.5t-316.5-131.5-316.5 131.5-131.5 316.5 131.5 316.5 316.5 131.5 316.5-131.5 131.5-316.5zm512 832q0 52-38 90t-90 38q-54 0-90-38l-343-342q-179 124-399 124-143 0-273.5-55.5t-225-150-150-225-55.5-273.5 55.5-273.5 150-225 225-150 273.5-55.5 273.5 55.5 225 150 150 225 55.5 273.5q0 220-124 399l343 343q37 37 37 90z"/></svg> </a> </div> </div> <div class="search"> <div class="main-nav-link"> <a href="https://brightdata.com/?utm_source=brand&utm_campaign=brnd-mkt_content_partner_slashdot_banner" rel="nofollow" target="_blank" id="main-nav-badge-link" data-label="BrightData2"> <img src="https://a.fsdn.com/con/assets/maxnav/sourceforge/brightdata2-137fa282.png" srcset="https://a.fsdn.com/con/assets/maxnav/sourceforge/brightdata2big-137fc37a.png 2x" alt="Bright Data - Real-Time Business Data" id="main-nav-image"/> </a> </div> <form method="get" action="/directory/" class="m-search-form"> <div class="typeahead__container"> <div class="typeahead__field"> <div class="typeahead__query"> <input type="text" placeholder="Search for software or solutions" autocomplete="off" name="q" > </div> <label> <input type="submit" class="bt" value=""> <svg data-name="search" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1216 832q0-185-131.5-316.5t-316.5-131.5-316.5 131.5-131.5 316.5 131.5 316.5 316.5 131.5 316.5-131.5 131.5-316.5zm512 832q0 52-38 90t-90 38q-54 0-90-38l-343-342q-179 124-399 124-143 0-273.5-55.5t-225-150-150-225-55.5-273.5 55.5-273.5 150-225 225-150 273.5-55.5 273.5 55.5 225 150 150 225 55.5 273.5q0 220-124 399l343 343q37 37 37 90z"/></svg> </label> </div> </div> </form> </div> </nav> </section> </div> <div class="notification-on-project-page"> </div> <section id="page-body" class=" neighborhood-Projects project-docutils mountpoint-code "> <div id="nav_menu_holder"> <div class="sandiego"> <section class="project-masthead"> <div class="backdrop" style="box-sizing: content-box; padding-bottom: 24px"></div> <div class="content"> <nav id="breadcrumbs" class="breadcrumbs rtl"> <ul itemscope itemtype="http://schema.org/BreadcrumbList"> <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"> <a itemprop="item" href="/"><span itemprop="name">Home</span></a> <meta itemprop="position" content="1"/> </li> <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"> <a itemprop="item" href="/directory/"><span itemprop="name">Browse</span></a> <meta itemprop="position" content="2"/> </li> <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"> <a itemprop="item" href="/p/docutils/"><span itemprop="name">Docutils: Documentation Utilities</span></a> <meta itemprop="position" content="3"/> </li> <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"> <span itemprop="name">Code</span> <meta itemprop="position" content="4"/> </li> </ul> </nav> <div class="overview"> <div class="project-icon default-project-icon " > <svg data-name="default-icon" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 300 300" style="enable-background:new 0 0 300 300;" xml:space="preserve"><rect class="st0" width="300" height="300"/><g><path class="st1" d="M162.5,154.8c0-28.9-10.2-42-15.6-46.9c-1.1-1-2.7-0.1-2.6,1.3c1.1,16.3-19.4,20.3-19.4,45.9h0c0,0.1,0,0.1,0,0.2c0,15.6,11.8,28.3,26.3,28.3c14.5,0,26.3-12.7,26.3-28.3c0-0.1,0-0.1,0-0.2h0c0-7.2-2.7-14.1-5.5-19.3c-0.5-1-2.1-0.6-1.9,0.3C174.9,158.1,162.5,171.8,162.5,154.8z"/><g><path class="st1" d="M131.2,215.6c-0.7,0-1.3-0.3-1.8-0.7l-67.2-67.1c-1-1-1-2.6,0-3.6l70.9-70.9c0.5-0.5,1.1-0.7,1.8-0.7h20.4c1.2,0,2,0.8,2.3,1.6c0.3,0.7,0.3,1.9-0.5,2.7l-66.7,66.7c-1.3,1.3-1.3,3.5,0,4.9l52.7,52.7c1,1,1,2.6,0,3.6L133,214.9C132.5,215.4,131.9,215.6,131.2,215.6z"/></g><g><path class="st1" d="M144.7,227.4c-1.2,0-2-0.8-2.3-1.5c-0.3-0.7-0.3-1.9,0.5-2.7l66.7-66.7c0.7-0.6,1-1.5,1-2.4s-0.4-1.8-1-2.4l-52.7-52.7c-1-1-1-2.6,0-3.6l10.2-10.2c0.5-0.5,1.1-0.7,1.8-0.7c0.7,0,1.3,0.3,1.8,0.7l67,67.1c0.5,0.5,0.7,1.1,0.7,1.8s-0.3,1.3-0.7,1.8l-70.9,70.9c-0.5,0.5-1.1,0.7-1.8,0.7H144.7z"/></g></g></svg> </div> <div class="title long-title"> <meta itemprop="name" content="Docutils: Documentation Utilities"/> <h1 class="long-title" >Docutils: Documentation Utilities Code </h1> <div class="as-h3 brought-by"> Brought to you by: <a href="/u/goodger/profile/">goodger</a>, <a href="/u/grubert/profile/">grubert</a>, <a href="/u/milde/profile/">milde</a>, <a href="/u/tibs/profile/">tibs</a>, <a href="/u/wiemann/profile/">wiemann</a> </div> </div> </div> </div> </section> </div> </div> <div id="top_nav" class=""> <div id="top_nav_admin"> <ul class="dropdown"> <li class=""> <a href="/projects/docutils/" class="tool-summary-32" > Summary </a> </li> <li class=""> <a href="/projects/docutils/files/" class="tool-files-sf-32" > Files </a> </li> <li class=""> <a href="/projects/docutils/reviews/" class="tool-reviews-32" > Reviews </a> </li> <li class=""> <a href="/projects/docutils/support" class="tool-support-32" > Support </a> </li> <li class=""> <a href="/p/docutils/mailman/" class="tool-mailman-32" > Mailing Lists </a> </li> <li class=""> <a href="/p/docutils/_list/tickets" class="tool-tickets-32" > Tickets ▾ </a> <ul> <li class=""><a href="/p/docutils/bugs/" >Bugs</a></li> <li class=""><a href="/p/docutils/feature-requests/" >Feature Requests</a></li> <li class=""><a href="/p/docutils/patches/" >Patches</a></li> <li class=""><a href="/p/docutils/support-requests/" >Support Requests</a></li> </ul> </li> <li class=""> <a href="/p/docutils/news/" class="tool-blog-32" > News </a> </li> <li class="selected"> <a href="/p/docutils/code/" class="tool-svn-32" > Code </a> </li> </ul> </div> </div> <div id="content_base"> <a id="sidebar-activate" href="#"> <span class="btn-label">Menu</span> <span class="btn-arrow-down">▾</span> <span class="btn-arrow-up">▴</span> </a> <div id="sidebar"> <div class="placeholder-no-searchbox"> </div> <ul class="sidebarmenu"> <li> <a class="icon" href="/p/docutils/code/commit_browser" rel="nofollow" title="Browse Commits"><i class="fa fa-list"></i> <span>Browse Commits</span> </a> </li> <li> <a href="/p/docutils/code/" rel="nofollow" > <span>Browse Files</span> </a> </li> </ul> </div> <script> $('#sidebar-admin-header').on('click', function(e){ $("#sidebar-admin-menu").toggleClass("hidden"); $(this).toggleClass("expanded"); e.preventDefault(); }); </script> <div class="grid-20 pad"> <h2 class="dark title"> <span> Tree <a href="/p/docutils/code/9989/" rel="nofollow">[r9989]</a> <a href="./../../" rel="nofollow"><b class="fa fa-folder-open-o" title="Root directory"></b></a> / <a href="./../" rel="nofollow">trunk</a> / <a href="./" rel="nofollow">docutils</a> / </span> <!-- actions --> <small> <form class="tarball" action="/p/docutils/code/HEAD/tarball" method="post"> <input type="hidden" name="path" value="/trunk/docutils" /> <button><span class="icon" title="Download Snapshot"><i class="fa fa-download"></i> Download Snapshot</span></button> <input name="_session_id" type="hidden" value="8d65ed30576c85cea56751f26704ff29b8af142797d9a6551ca0c6e4e8612f51b69060e01c84ea39"> </form> <a class="icon" href="/p/docutils/code/9989/log/?path=/trunk/docutils" rel="nofollow" title="History"><i class="fa fa-calendar"></i> History</a> <a class="icon" href="/p/docutils/code/feed/" rel="nofollow" title="Feed"><i class="fa fa-rss"></i></a> </small> <!-- /actions --> </h2> <div> <div id="access_urls" class="btn-bar grid-19"> <div class="btn-set duo"> <a class="btn" data-url="svn checkout https://svn.code.sf.net/p/docutils/code/trunk docutils-code" title="HTTPS"> HTTPS </a> <a class="btn" data-url="svn checkout svn://svn.code.sf.net/p/docutils/code/trunk docutils-code" title="svn://"> svn:// </a> </div> <span>HTTPS access</span> <div> <input id="access_url" readonly type="text" class="selectText" value="svn checkout https://svn.code.sf.net/p/docutils/code/trunk docutils-code"/> </div> </div> <hr> <br style="clear:both"/> <table> <thead> <tr> <th>File</th> <th>Date</th> <th>Author</th> <th>Commit</th> </tr> </thead> <tbody> <tr> <td class="nowrap"> <a class="icon" href="docs" rel="nofollow" title="docs"><i class="fa fa-folder"></i> docs</a> </td> <td class="nowrap"> <span title="Tue Nov 12, 2024 10:34 AM UTC"> 2024-11-12 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> milde </td> <td> <a href="/p/docutils/code/9980/" rel="nofollow"> [r9980] Announce upcoming change in "doctest block" han... </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="docutils" rel="nofollow" title="docutils"><i class="fa fa-folder"></i> docutils</a> </td> <td class="nowrap"> <span title="Sun Nov 24, 2024 05:15 PM UTC"> 16 hours ago </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> grubert </td> <td> <a href="/p/docutils/code/9989/" rel="nofollow"> [r9989] manpage writer: extract encode_special_chars fr... </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="licenses" rel="nofollow" title="licenses"><i class="fa fa-folder"></i> licenses</a> </td> <td class="nowrap"> <span title="Sat Nov 09, 2024 11:59 PM UTC"> 2024-11-09 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> milde </td> <td> <a href="/p/docutils/code/9978/" rel="nofollow"> [r9978] Change extension of the local GPL 3 license cop... </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="test" rel="nofollow" title="test"><i class="fa fa-folder"></i> test</a> </td> <td class="nowrap"> <span title="Thu Nov 14, 2024 05:50 PM UTC"> 2024-11-14 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> grubert </td> <td> <a href="/p/docutils/code/9982/" rel="nofollow"> [r9982] manpage writer: </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="tools" rel="nofollow" title="tools"><i class="fa fa-folder"></i> tools</a> </td> <td class="nowrap"> <span title="Thu Aug 15, 2024 08:43 AM UTC"> 2024-08-15 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> grubert </td> <td> <a href="/p/docutils/code/9906/" rel="nofollow"> [r9906] rename txt to rst </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href=".flake8" rel="nofollow" title=".flake8"><i class="fa fa-file-o"></i> .flake8</a> </td> <td class="nowrap"> <span title="Mon Oct 21, 2024 07:20 AM UTC"> 2024-10-21 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> milde </td> <td> <a href="/p/docutils/code/9957/" rel="nofollow"> [r9957] Catch deliberate system messages when running t... </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href=".ruff.toml" rel="nofollow" title=".ruff.toml"><i class="fa fa-file-o"></i> .ruff.toml</a> </td> <td class="nowrap"> <span title="Fri Aug 09, 2024 04:52 AM UTC"> 2024-08-09 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> aa-turner </td> <td> <a href="/p/docutils/code/9871/" rel="nofollow"> [r9871] Fix Ruff </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="BUGS.rst" rel="nofollow" title="BUGS.rst"><i class="fa fa-file-o"></i> BUGS.rst</a> </td> <td class="nowrap"> <span title="Thu Aug 15, 2024 08:43 AM UTC"> 2024-08-15 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> grubert </td> <td> <a href="/p/docutils/code/9906/" rel="nofollow"> [r9906] rename txt to rst </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="COPYING.rst" rel="nofollow" title="COPYING.rst"><i class="fa fa-file-o"></i> COPYING.rst</a> </td> <td class="nowrap"> <span title="Sat Nov 09, 2024 11:36 PM UTC"> 2024-11-09 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> milde </td> <td> <a href="/p/docutils/code/9977/" rel="nofollow"> [r9977] Remove `docutils/utils/roman.py`. </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="FAQ.rst" rel="nofollow" title="FAQ.rst"><i class="fa fa-file-o"></i> FAQ.rst</a> </td> <td class="nowrap"> <span title="Sun Oct 20, 2024 06:57 PM UTC"> 2024-10-20 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> milde </td> <td> <a href="/p/docutils/code/9955/" rel="nofollow"> [r9955] Small fixes and additions. </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="HISTORY.rst" rel="nofollow" title="HISTORY.rst"><i class="fa fa-file-o"></i> HISTORY.rst</a> </td> <td class="nowrap"> <span title="Mon Nov 18, 2024 04:50 PM UTC"> 7 days ago </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> grubert </td> <td> <a href="/p/docutils/code/9986/" rel="nofollow"> [r9986] if macro references is active output refuri alw... </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="README.rst" rel="nofollow" title="README.rst"><i class="fa fa-file-o"></i> README.rst</a> </td> <td class="nowrap"> <span title="Fri Oct 18, 2024 08:57 AM UTC"> 2024-10-18 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> milde </td> <td> <a href="/p/docutils/code/9951/" rel="nofollow"> [r9951] Document, that type hints use Python 3.10 syntax. </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="RELEASE-NOTES.rst" rel="nofollow" title="RELEASE-NOTES.rst"><i class="fa fa-file-o"></i> RELEASE-NOTES.rst</a> </td> <td class="nowrap"> <span title="Mon Nov 18, 2024 12:55 PM UTC"> 7 days ago </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> milde </td> <td> <a href="/p/docutils/code/9984/" rel="nofollow"> [r9984] Announce change to rst parser: warn for figure ... </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="THANKS.rst" rel="nofollow" title="THANKS.rst"><i class="fa fa-file-o"></i> THANKS.rst</a> </td> <td class="nowrap"> <span title="Thu Aug 15, 2024 08:43 AM UTC"> 2024-08-15 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> grubert </td> <td> <a href="/p/docutils/code/9906/" rel="nofollow"> [r9906] rename txt to rst </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="docutils.conf" rel="nofollow" title="docutils.conf"><i class="fa fa-file-o"></i> docutils.conf</a> </td> <td class="nowrap"> <span title="Thu Aug 15, 2024 08:43 AM UTC"> 2024-08-15 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> grubert </td> <td> <a href="/p/docutils/code/9906/" rel="nofollow"> [r9906] rename txt to rst </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="pyproject.toml" rel="nofollow" title="pyproject.toml"><i class="fa fa-file-o"></i> pyproject.toml</a> </td> <td class="nowrap"> <span title="Thu Aug 15, 2024 08:43 AM UTC"> 2024-08-15 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> grubert </td> <td> <a href="/p/docutils/code/9906/" rel="nofollow"> [r9906] rename txt to rst </a> </td> </tr> <tr> <td class="nowrap"> <a class="icon" href="tox.ini" rel="nofollow" title="tox.ini"><i class="fa fa-file-o"></i> tox.ini</a> </td> <td class="nowrap"> <span title="Wed Jul 31, 2024 07:43 AM UTC"> 2024-07-31 </span> </td> <td class="nowrap"> <span class="icon emboss x16" style="text-align:center;" title="User"><i class="fa fa-user"></i></span> aa-turner </td> <td> <a href="/p/docutils/code/9793/" rel="nofollow"> [r9793] Add Python 3.13 to tox </a> </td> </tr> </tbody> </table> <h1 id="readme">Read Me</h1> <div class="document"> <div class="section" id="readme-docutils-0-22b-dev"> <h1><a class="toc-backref" href="#toc-entry-1" rel="nofollow">README: Docutils 0.22b.dev</a></h1> <table class="docutils field-list" frame="void" rules="none"> <colgroup><col class="field-name"> <col class="field-body"> </colgroup><tbody valign="top"> <tr class="field"><th class="field-name">Author:</th><td class="field-body">David Goodger</td> </tr> <tr class="field"><th class="field-name">Contact:</th><td class="field-body"><a class="reference external" href="mailto:goodger%40python.org">goodger<span>@</span>python<span>.</span>org</a></td> </tr> <tr class="field"><th class="field-name">Date:</th><td class="field-body">$Date$</td> </tr> <tr class="field"><th class="field-name">Web site:</th><td class="field-body"><a class="reference external" href="https://docutils.sourceforge.io/" rel="nofollow">https://docutils.sourceforge.io/</a></td> </tr> <tr class="field"><th class="field-name">Copyright:</th><td class="field-body">This document has been placed in the public domain.</td> </tr> </tbody> </table> <div class="contents topic" id="contents"> <p class="topic-title"><a class="reference internal" href="#top" rel="nofollow">Contents</a></p> <ul class="simple"> <li><a class="reference internal" href="#readme-docutils-0-22b-dev" id="toc-entry-1" rel="nofollow">README: Docutils 0.22b.dev</a><ul> <li><a class="reference internal" href="#quick-start" id="toc-entry-2" rel="nofollow">Quick-Start</a></li> <li><a class="reference internal" href="#purpose" id="toc-entry-3" rel="nofollow">Purpose</a></li> <li><a class="reference internal" href="#dependencies" id="toc-entry-4" rel="nofollow">Dependencies</a><ul> <li><a class="reference internal" href="#recommendations" id="toc-entry-5" rel="nofollow">Recommendations</a></li> </ul> </li> <li><a class="reference internal" href="#installation" id="toc-entry-6" rel="nofollow">Installation</a><ul> <li><a class="reference internal" href="#gnu-linux-bsds-unix-mac-os-x-etc" id="toc-entry-7" rel="nofollow">GNU/Linux, BSDs, Unix, Mac OS X, etc.</a></li> <li><a class="reference internal" href="#windows" id="toc-entry-8" rel="nofollow">Windows</a></li> </ul> </li> <li><a class="reference internal" href="#usage" id="toc-entry-9" rel="nofollow">Usage</a></li> <li><a class="reference internal" href="#project-files-directories" id="toc-entry-10" rel="nofollow">Project Files & Directories</a></li> <li><a class="reference internal" href="#development-version" id="toc-entry-11" rel="nofollow">Development version</a></li> <li><a class="reference internal" href="#converting-the-documentation" id="toc-entry-12" rel="nofollow">Converting the documentation</a></li> <li><a class="reference internal" href="#running-the-test-suite" id="toc-entry-13" rel="nofollow">Running the Test Suite</a></li> <li><a class="reference internal" href="#getting-help" id="toc-entry-14" rel="nofollow">Getting Help</a></li> </ul> </li> </ul> </div> <div class="section" id="quick-start"> <h2><a class="toc-backref" href="#toc-entry-2" rel="nofollow">Quick-Start</a></h2> <p>This is for those who want to get up & running quickly.</p> <ol class="arabic"> <li><p class="first">Docutils requires <strong>Python</strong>, available from <a class="reference external" href="https://www.python.org/" rel="nofollow">https://www.python.org/</a>. See <a class="reference internal" href="#dependencies" rel="nofollow">Dependencies</a> below for details.</p> </li> <li><p class="first">Install the latest stable release from PyPi with <a class="reference external" href="https://pypi.org/project/pip/" rel="nofollow">pip</a>:</p> <pre class="literal-block">pip install docutils </pre> <p>For alternatives and details, see section <a class="reference internal" href="#installation" rel="nofollow">Installation</a> below.</p> </li> <li><p class="first">Use the <a class="reference external" href="docs/user/tools.html" rel="nofollow">front-end scripts</a> to convert reStructuredText documents. Try for example:</p> <pre class="literal-block">docutils FAQ.rst FAQ.html </pre> <p>See <a class="reference internal" href="#usage" rel="nofollow">Usage</a> below for details.</p> </li> </ol> </div> <div class="section" id="purpose"> <h2><a class="toc-backref" href="#toc-entry-3" rel="nofollow">Purpose</a></h2> <p>The purpose of the Docutils project is to provide a set of tools for processing plaintext documentation into useful formats, such as HTML, LaTeX, troff (man pages), OpenOffice, and native XML. Support for the following sources has been implemented:</p> <ul class="simple"> <li>Standalone files.</li> <li><a class="reference external" href="https://peps.python.org/pep-0012" rel="nofollow">PEPs (Python Enhancement Proposals)</a>.</li> </ul> <p>Support for the following sources is planned or provided by <a class="reference external" href="docs/user/links.html#related-applications" rel="nofollow">third party tools</a>:</p> <ul class="simple"> <li>Inline documentation from Python modules and packages, extracted with namespace context.</li> <li>Email (RFC-822 headers, quoted excerpts, signatures, MIME parts).</li> <li>Wikis, with global reference lookups of "wiki links".</li> <li>Compound documents, such as multiple chapter files merged into a book.</li> <li>And others as discovered.</li> </ul> </div> <div class="section" id="dependencies"> <h2><a class="toc-backref" href="#toc-entry-4" rel="nofollow">Dependencies</a></h2> <p>To run the code, <a class="reference external" href="https://www.python.org/." rel="nofollow">Python</a> must be installed. (Python is pre-installed with most Linux distributions.)</p> <ul class="simple"> <li>Since version 0.21, Docutils requires Python 3.9 or later.</li> <li>Docutils versions 0.19 to 0.20.1 require Python 3.7 or later.</li> <li>Docutils versions 0.16 to 0.18 require Python 2.7 or 3.5+.</li> </ul> <p>The <strong>type hints</strong> added in version 0.22 use Python 3.10 syntax. However, the Python interpreter treats them as annotations unless <tt class="docutils literal">typing.TYPE_CHECKING</tt> is set to <tt class="docutils literal">True</tt>.</p> <div class="section" id="recommendations"> <h3><a class="toc-backref" href="#toc-entry-5" rel="nofollow">Recommendations</a></h3> <p>Docutils uses the following packages for enhanced functionality, if they are installed:</p> <ul class="simple"> <li>The recommended installer is <a class="reference external" href="https://pypi.org/project/pip/" rel="nofollow">pip</a>, <a class="reference external" href="https://pypi.org/project/setuptools/" rel="nofollow">setuptools</a> works, too.</li> <li>The <a class="reference external" href="http://www.pythonware.com/products/pil/" rel="nofollow">Python Imaging Library</a> (PIL) is used for some image manipulation operations.</li> <li>The <a class="reference external" href="https://pypi.org/project/Pygments/" rel="nofollow">Pygments</a> package provides syntax highlight of "code" directives and roles.</li> <li>The <a class="reference external" href="https://pypi.org/project/myst-docutils/" rel="nofollow">myst</a>, <a class="reference external" href="https://pypi.org/project/pycmark/" rel="nofollow">pycmark</a>, or <a class="reference external" href="https://github.com/rtfd/recommonmark" rel="nofollow">recommonmark</a> parsers can be used to parse input in "Markdown" (<a class="reference external" href="https://spec.commonmark.org/0.30/" rel="nofollow">CommonMark</a>) format.</li> </ul> <p>The <a class="reference external" href="docs/user/links.html" rel="nofollow">Docutils Link List</a> records projects that users of Docutils and reStructuredText may find useful.</p> </div> </div> <div class="section" id="installation"> <h2><a class="toc-backref" href="#toc-entry-6" rel="nofollow">Installation</a></h2> <p>The <a class="reference external" href="https://packaging.python.org/en/latest/" rel="nofollow">Python Packaging User Guide</a> gives details how to <a class="reference external" href="https://packaging.python.org/en/latest/tutorials/installing-packages/#use-pip-for-installing" rel="nofollow">use pip for installing</a>.</p> <ul> <li><p class="first">The simplest way is to install the latest <em>stable release</em> from PyPi:</p> <pre class="literal-block">pip install docutils </pre> </li> <li><p class="first">To install a <em>pre-relase</em>, append the option <tt class="docutils literal"><span class="pre">--pre</span></tt>.</p> </li> <li><p class="first">To install a <a class="reference internal" href="#development-version" rel="nofollow">development version</a> <em>from source</em>:</p> <ol class="arabic"> <li><p class="first">Open a shell</p> </li> <li><p class="first">Go to the directory containing the <tt class="docutils literal">pyproject.toml</tt> file.</p> </li> <li><p class="first">Install the package with <strong>one</strong> of the following commands:</p> <pre class="literal-block">pip install -e . # editable install pip install . # regular install </pre> <p>or do a <a class="reference external" href="docs/dev/repository.html#manual-install" rel="nofollow">"manual" install</a>.</p> </li> <li><p class="first">Optional steps:</p> <ul class="simple"> <li><a class="reference internal" href="#running-the-test-suite" rel="nofollow">Running the test suite</a></li> <li><a class="reference internal" href="#converting-the-documentation" rel="nofollow">Converting the documentation</a></li> </ul> </li> </ol> <p>See also the OS-specific installation instructions below and the <a class="reference external" href="docs/dev/repository.html" rel="nofollow">Docutils version repository</a> documentation.</p> </li> <li><p class="first">To install for a <em>specific Python version</em>, use this version in the setup call, e.g.</p> <pre class="literal-block">python3.11 -m pip install docutils </pre> <p>If the python executable isn't on your path, you'll have to specify the complete path, such as <tt class="docutils literal">/usr/local/bin/python3.11</tt>.</p> <p>To install for different Python versions, repeat step 3 for every required version. The last installed version will be used for the <tt class="docutils literal">docutils</tt> command line application.</p> </li> </ul> <div class="section" id="gnu-linux-bsds-unix-mac-os-x-etc"> <h3><a class="toc-backref" href="#toc-entry-7" rel="nofollow">GNU/Linux, BSDs, Unix, Mac OS X, etc.</a></h3> <ul> <li><p class="first">Use <tt class="docutils literal">su</tt> or <tt class="docutils literal">sudo</tt> for a system-wide installation as <tt class="docutils literal">root</tt>, e.g.:</p> <pre class="literal-block">sudo pip install docutils </pre> </li> </ul> </div> <div class="section" id="windows"> <h3><a class="toc-backref" href="#toc-entry-8" rel="nofollow">Windows</a></h3> <ul> <li><p class="first">The Python FAQ explains <a class="reference external" href="https://docs.python.org/3/faq/windows.html#how-do-i-run-a-python-program-under-windows" rel="nofollow">how to run a Python program under Windows</a>.</p> </li> <li><p class="first">Usually, <a class="reference external" href="https://pypi.org/project/pip/" rel="nofollow">pip</a> is automatically installed if you are using Python downloaded from <a class="reference external" href="https://python.org" rel="nofollow">https://python.org</a>. If not, see the <a class="reference external" href="https://pip.pypa.io/en/stable/installation/" rel="nofollow">pip documentation</a>.</p> </li> <li><p class="first">The command window should recognise the word <tt class="docutils literal">py</tt> as an instruction to start the interpreter, e.g.</p> <blockquote> <p>py -m pip install docutils</p> </blockquote> <p>If this does not work, you may have to specify the full path to the Python executable.</p> </li> </ul> </div> </div> <div class="section" id="usage"> <h2><a class="toc-backref" href="#toc-entry-9" rel="nofollow">Usage</a></h2> <p>Start the "docutils" command line application with:</p> <pre class="literal-block">docutils [options] [<source> [<destination>]] </pre> <p>The default action is to convert a <a class="reference external" href="https://docutils.sourceforge.io/rst.html" rel="nofollow">reStructuredText</a> document to HTML5, for example:</p> <pre class="literal-block">docutils test.rst test.html </pre> <p>Read the <tt class="docutils literal"><span class="pre">--help</span></tt> option output for details on options and arguments and <a class="reference external" href="docs/user/tools.html" rel="nofollow">Docutils Front-End Tools</a> for the full documentation of the various tools.</p> <p>For programmatic use of the <cite>docutils</cite> Python package, read the <a class="reference external" href="/docs/index.html#api-reference-material-for-client-developers" rel="nofollow">API Reference Material</a> and the source code. Remaining questions may be answered in the <a class="reference external" href="/docs/index.html" rel="nofollow">Docutils Project Documentation</a> or the <a class="reference external" href="docs/user/mailing-lists.html#docutils-users" rel="nofollow">Docutils-users</a> mailing list.</p> <p>Contributions are welcome!</p> </div> <div class="section" id="project-files-directories"> <h2><a class="toc-backref" href="#toc-entry-10" rel="nofollow">Project Files & Directories</a></h2> <ul class="simple"> <li>README.rst: You're reading it.</li> <li>COPYING.rst: Public Domain Dedication and copyright details for non-public-domain files (most are PD).</li> <li>FAQ.rst: Frequently Asked Questions (with answers!).</li> <li>RELEASE-NOTES.rst: Summary of the major changes in recent releases.</li> <li>HISTORY.rst: A detailed change log, for the current and all previous project releases.</li> <li>BUGS.rst: Known bugs, and how to report a bug.</li> <li>THANKS.rst: List of contributors.</li> <li>pyproject.toml: Project metadata. See "Installation" above.</li> <li>docutils: The project source directory, installed as a Python package.</li> <li>docs: The project documentation directory. Read <tt class="docutils literal">docs/index.rst</tt> for an overview.</li> <li>docs/user: The project user documentation directory. Contains the following documents, among others:<ul> <li>docs/user/tools.rst: Docutils Front-End Tools</li> <li>docs/user/latex.rst: Docutils LaTeX Writer</li> <li>docs/user/rst/quickstart.rst: A ReStructuredText Primer</li> <li>docs/user/rst/quickref.html: Quick reStructuredText (HTML only)</li> </ul> </li> <li>docs/ref: The project reference directory. <tt class="docutils literal">docs/ref/rst/restructuredtext.rst</tt> is the reStructuredText reference.</li> <li>licenses: Directory containing copies of license files for non-public-domain files.</li> <li>tools: Directory for Docutils front-end tools. See <tt class="docutils literal">docs/user/tools.rst</tt> for documentation.</li> <li>test: Unit tests. Not required to use the software, but very useful if you're planning to modify it. See <a class="reference internal" href="#running-the-test-suite" rel="nofollow">Running the Test Suite</a> below.</li> </ul> </div> <div class="section" id="development-version"> <h2><a class="toc-backref" href="#toc-entry-11" rel="nofollow">Development version</a></h2> <p>While we are trying to follow a "release early & often" policy, features are added frequently. We recommend using a current snapshot or a working copy of the repository.</p> <dl class="docutils"> <dt>Repository check-out:</dt> <dd>To keep up to date on the latest developments, use a <a class="reference external" href="docs/dev/repository.html#checking-out-the-repository" rel="nofollow">working copy</a> of the <a class="reference external" href="docs/dev/repository.html" rel="nofollow">Docutils version repository</a>.</dd> <dt>Snapshots:</dt> <dd><p class="first">To get a repository <span class="target" id="snapshot">snapshot</span>, go to <a class="reference external" href="https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/" rel="nofollow">https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/</a> and click the download snapshot button.</p> <p class="last">Unpack in a temporary directory, <strong>not</strong> directly in Python's <tt class="docutils literal"><span class="pre">site-packages</span></tt>.</p> </dd> </dl> <p>See the <a class="reference internal" href="#installation" rel="nofollow">Installation</a> instructions above.</p> </div> <div class="section" id="converting-the-documentation"> <h2><a class="toc-backref" href="#toc-entry-12" rel="nofollow">Converting the documentation</a></h2> <p>After unpacking and installing the Docutils package, the following shell commands will generate HTML for all included documentation:</p> <pre class="literal-block">cd <archive_directory_path> tools/buildhtml.py . </pre> <p>On Windows systems, type:</p> <pre class="literal-block">cd <archive_directory_path> py tools\buildhtml.py .. </pre> <p>The final directory name of the <tt class="docutils literal"><archive_directory_path></tt> is "docutils" for snapshots. For official releases, the directory may be called "docutils-X.Y.Z", where "X.Y.Z" is the release version.</p> <p>Some files may generate system messages (warnings and errors). The <tt class="docutils literal">docs/user/rst/demo.rst</tt> file (under the archive directory) contains five intentional errors. (They test the error reporting mechanism!)</p> </div> <div class="section" id="running-the-test-suite"> <h2><a class="toc-backref" href="#toc-entry-13" rel="nofollow">Running the Test Suite</a></h2> <p>The test suite is documented in <a class="reference external" href="https://docutils.sourceforge.io/docs/dev/testing.html" rel="nofollow">Docutils Testing</a> (docs/dev/testing.rst).</p> <p>To run the entire test suite, open a shell and use the following commands:</p> <pre class="literal-block">cd <archive_directory_path>/test ./alltests.py </pre> <p>Under Windows, type:</p> <pre class="literal-block">cd <archive_directory_path>\test python alltests.py </pre> <p>You should see a long line of periods, one for each test, and then a summary like this:</p> <pre class="literal-block">Ran 1744 tests in 5.859s OK (skipped=1) Elapsed time: 6.235 seconds </pre> <p>The number of tests will grow over time, and the times reported will depend on the computer running the tests. Some test are skipped, if optional dependencies (<a class="reference internal" href="#recommendations" rel="nofollow">recommendations</a>) are missing. The difference between the two times represents the time required to set up the tests (import modules, create data structures, etc.).</p> <p>A copy of the test output is written to the file <tt class="docutils literal">alltests.out</tt>.</p> <p>If any of the tests fail, please <a class="reference external" href="https://sourceforge.net/p/docutils/bugs/" rel="nofollow">open a bug report</a> or <a class="reference external" href="mailto:docutils-users%40lists.sourceforge.net?subject=Test%20suite%20failure">send an email</a> (see <a class="reference external" href="BUGS.html" rel="nofollow">Bugs</a>). Please include all relevant output, information about your operating system, Python version, and Docutils version. To see the Docutils version, look at the test output or use</p> <pre class="literal-block">docutils --version </pre> </div> <div class="section" id="getting-help"> <h2><a class="toc-backref" href="#toc-entry-14" rel="nofollow">Getting Help</a></h2> <p>All documentation can be reached from the <a class="reference external" href="docs/index.html" rel="nofollow">Project Documentation Overview</a>.</p> <p>The SourceForge <a class="reference external" href="https://sourceforge.net/p/docutils" rel="nofollow">project page</a> has links to the tracker, mailing lists, and code repository.</p> <p>If you have further questions or need assistance with Docutils or reStructuredText, please post a message to the <a class="reference external" href="docs/user/mailing-lists.html#docutils-users" rel="nofollow">Docutils-users</a> mailing list.</p> </div> </div> </div> </div> </div> </div> </section> <footer class="sandiego"> <div class="as-row"> <div class="footer-wrapper"> <nav aria-label="Site Links" role="navigation"> <section> <div class="as-h2">SourceForge</div> <ul> <li><a href="/create/" title="Create a Project">Create a Project</a></li> <li><a href="/directory/" title="Open Source Software Directory">Open Source Software</a></li> <li><a href="/software/" title="Business Software Directory">Business Software</a></li> <li><a href="/top" title="Top Open Source Projects">Top Downloaded Projects</a></li> </ul> </section> </nav> <nav aria-label="Company Links" role="navigation"> <section> <div class="as-h2">Company</div> <ul> <li><a href="/about">About</a></li> <li><a href="/about/leadership" title="Open Source Software Directory">Team</a></li> <li class="h-card"> <address> <span class="p-name p-org">SourceForge Headquarters</span><br> <span class="p-street-address">225 Broadway Suite 1600</span><br> <span class="p-locality">San Diego, CA <span class="p-postal-code">92101</span></span><br> <span class="p-tel">+1 (858) 454-5900</span><br> </address> </li> <li id="social"> <span></span> <a href="https://twitter.com/sourceforge" class="twitter" rel="nofollow" target="_blank" title="SourceForge on X"> <svg class="vertical-icon-fix" data-name="twitter" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1684 408q-67 98-162 167 1 14 1 42 0 130-38 259.5t-115.5 248.5-184.5 210.5-258 146-323 54.5q-271 0-496-145 35 4 78 4 225 0 401-138-105-2-188-64.5t-114-159.5q33 5 61 5 43 0 85-11-112-23-185.5-111.5t-73.5-205.5v-4q68 38 146 41-66-44-105-115t-39-154q0-88 44-163 121 149 294.5 238.5t371.5 99.5q-8-38-8-74 0-134 94.5-228.5t228.5-94.5q140 0 236 102 109-21 205-78-37 115-142 178 93-10 186-50z"/></svg></a> <a href="https://fosstodon.org/@sourceforge" rel="me nofollow" target="_blank" title="SourceForge on Mastodon"> <svg class="vertical-icon-fix" data-name="mastodon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M433 179.11c0-97.2-63.71-125.7-63.71-125.7-62.52-28.7-228.56-28.4-290.48 0 0 0-63.72 28.5-63.72 125.7 0 115.7-6.6 259.4 105.63 289.1 40.51 10.7 75.32 13 103.33 11.4 50.81-2.8 79.32-18.1 79.32-18.1l-1.7-36.9s-36.31 11.4-77.12 10.1c-40.41-1.4-83-4.4-89.63-54a102.54 102.54 0 0 1-.9-13.9c85.63 20.9 158.65 9.1 178.75 6.7 56.12-6.7 105-41.3 111.23-72.9 9.8-49.8 9-121.5 9-121.5zm-75.12 125.2h-46.63v-114.2c0-49.7-64-51.6-64 6.9v62.5h-46.33V197c0-58.5-64-56.6-64-6.9v114.2H90.19c0-122.1-5.2-147.9 18.41-175 25.9-28.9 79.82-30.8 103.83 6.1l11.6 19.5 11.6-19.5c24.11-37.1 78.12-34.8 103.83-6.1 23.71 27.3 18.4 53 18.4 175z"/></svg></a> <a href="https://www.facebook.com/sourceforgenet/" class="facebook" rel="nofollow" target="_blank" title="SourceForge on Facebook"> <svg data-name="facebook" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1343 12v264h-157q-86 0-116 36t-30 108v189h293l-39 296h-254v759h-306v-759h-255v-296h255v-218q0-186 104-288.5t277-102.5q147 0 228 12z"/></svg></a> <a href="https://www.linkedin.com/company/sourceforge.net" class="linkedin" rel="nofollow" target="_blank" title="SourceForge on LinkedIn"> <svg data-name="linkedin" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M477 625v991h-330v-991h330zm21-306q1 73-50.5 122t-135.5 49h-2q-82 0-132-49t-50-122q0-74 51.5-122.5t134.5-48.5 133 48.5 51 122.5zm1166 729v568h-329v-530q0-105-40.5-164.5t-126.5-59.5q-63 0-105.5 34.5t-63.5 85.5q-11 30-11 81v553h-329q2-399 2-647t-1-296l-1-48h329v144h-2q20-32 41-56t56.5-52 87-43.5 114.5-15.5q171 0 275 113.5t104 332.5z"/></svg></a> <a href="/user/newsletters" rel=nofollow class="newsletter" title="Subscribe to our newsletter"> <svg class="vertical-icon-fix" data-name="mmSF_11mail" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 42 42" enable-background="new 0 0 42 42" xml:space="preserve"><path fill="#FFFFFF" d="M0,6v30h42V6H0z M24.2,21.2c-0.8,0.8-2.3,2-3.2,2c-0.9,0-2.4-1.2-3.2-2L5.8,9.7h30.3L24.2,21.2z M13.7,21l-9.9,9.4V11.6L13.7,21z M15.7,23L15.7,23c0.5,0.5,2.9,2.9,5.3,2.9c2.4,0,4.8-2.4,5.2-2.8l0.1-0.1l9.8,9.4H5.8L15.7,23z M28.3,21l9.9-9.5v18.9L28.3,21z"/></svg></a> <span></span> </li> </ul> </section> </nav> <nav aria-label="Resources Links" role="navigation"> <section> <div class="as-h2">Resources</div> <ul> <li><a href="/support" title="Support Section">Support</a></li> <li><a href="/p/forge/documentation/Docs%20Home/" title="Site Documentation">Site Documentation</a></li> <li><a href="https://fosstodon.org/@sourceforgestatus" title="Site Status" rel="me nofollow">Site Status</a></li> <li><a href="/reviews" title="Reviews" rel="me nofollow">SourceForge Reviews</a></li> </ul> </section> </nav> <section class="footer-logo"> <a href="/" title="Home" class="sf-logo"> <img src="https://a.fsdn.com/con/images/sandiego/sf-logo-full.svg" alt="SourceForge logo" class="sf-logo-full"/> </a> </section> </div> </div> <section class="l-nav-bottom"> <nav class="row"> <div class="columns small-12 large-6 copyright-notice"> © 2024 Slashdot Media. All Rights Reserved. </div> <div class="columns large-6 links links-right"> <a href="https://slashdotmedia.com/terms-of-use" target="_blank" title="Terms" rel="nofollow">Terms</a> <a href="https://slashdotmedia.com/privacy-statement/" target="_blank" title="Privacy" rel="nofollow">Privacy</a> <a href="https://slashdotmedia.com/opt-out-choices" target="_blank" title="Opt Out" rel="nofollow">Opt Out</a> <a href="https://slashdotmedia.com/contact/" target="_blank" title="Advertise" rel="nofollow">Advertise</a> </div> </nav> </section> </footer> </div> <div id="messages"> </div> <!-- ew:body_js --> <script type="text/javascript" src="https://a.fsdn.com/allura/nf/1732305734/_ew_/_slim/js?href=allura%2Fjs%2Fjquery.notify.js%3Ballura%2Fjs%2Fjquery.tooltipster.js%3Ballura%2Fjs%2Fallura-base.js%3Ballura%2Fjs%2Fchecklist.js%3Ballura%2Fjs%2Fadmin_modal.js%3Bjs%2Fjquery.lightbox_me.js%3Ballura%2Fjs%2Fmemorable.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fshared.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fsticky.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fsandiego%2Fchrome.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fsandiego%2Futilities.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.core.min.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.util.mediaQuery.min.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.util.keyboard.min.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.util.box.min.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.util.nest.min.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.dropdownMenu.min.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.offcanvas.min.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.toggler.min.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fsandiego%2Fproject.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Fjquery.typeahead.min.js"></script> <!-- /ew:body_js --> <!-- ew:body_js_tail --> <script type="text/javascript" src="https://a.fsdn.com/allura/nf/1732305734/_ew_/_slim/js?href=theme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.util.triggers.min.js%3Btheme%2Fsftheme%2Fjs%2Fsftheme%2Fvendor%2Ffoundation6%2Fplugins%2Ffoundation.reveal.min.js"></script> <!-- /ew:body_js_tail --> <script type="text/javascript">(function() { $('#access_urls .btn').click(function(evt){ evt.preventDefault(); var parent = $(this).parents('.btn-bar'); var checkout_cmd = $(this).attr('data-url'); $(parent).find('input').val(checkout_cmd); $(parent).find('span').text($(this).attr('title')+' access'); $(this).parent().children('.btn').removeClass('active'); $(this).addClass('active'); if (checkout_cmd.indexOf(' http://') !== -1 || checkout_cmd.indexOf(' https://') !== -1 ) { $('#http-2fa-msg').show(); } else { $('#http-2fa-msg').hide(); } }); $('#access_urls .btn').first().click(); var repo_status = document.getElementById('repo_status'); // The repo_status div will only be present if repo.status != 'ready' if (repo_status) { $('.spinner').show() var delay = 500; function check_status() { $.get('/p/docutils/code/status', function(data) { if (data.status === 'ready') { $('.spinner').hide() $('#repo_status h2').html('Repo status: ready. <a href="." rel="nofollow">Click here to refresh this page.</a>'); } else { $('#repo_status h2 span').html(data.status); if (delay < 60000){ delay = delay * 2; } window.setTimeout(check_status, delay); } }); } var status_checker = window.setTimeout(check_status, delay); } }()); </script> <noscript><p><img src="https://analytics.slashdotmedia.com/index.php?idsite=39" style="border:0;position:absolute;top:0;" alt="" /></p></noscript> <script> $(document).foundation(); </script> <!-- CCM Tag --> <script> (function () { bizx.cmp.ifConsent({ purposes: 'all', vendors: 'bombora'}, function () { /*global _ml:true, window */ _ml = window._ml || {}; _ml.eid = '771'; _ml.fp = '170e610b-fb59-4fa8-8e28-f9861c1edc4f'; var s = document.getElementsByTagName('script')[0], cd = new Date(), mltag = document.createElement('script'); mltag.type = 'text/javascript'; mltag.async = true; mltag.defer = true; mltag.src = '//ml314.com/tag.aspx?' + cd.getDate() + cd.getMonth() + cd.getFullYear(); s.parentNode.insertBefore(mltag, s); }); })(); </script> <!-- End CCM Tag --> <script> $(document).ready(function () { $(".tooltip, .m-tooltip").each(function(){ let $el = $(this); $el.tooltipster({ animation: 'fade', delay: 200, theme: 'tooltipster-light', trigger: 'hover', position: $el.data('position') || 'right', iconCloning: false, maxWidth: 300, contentAsHTML: true, interactive: true }).focus(function () { $(this).tooltipster('show'); }).blur(function () { $(this).tooltipster('hide'); }); }); }); </script> <script type="text/javascript"> bizx.cmp.ifConsent('', ['all'], function () { /* jshint ignore:start */ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); /* jshint ignore:end */ window.dataLayer = window.dataLayer || []; function gtag(){ window.dataLayer.push(arguments); } window.gtag = window.gtag || gtag; bizx.cmp.embedScript("https://www.googletagmanager.com/gtag/js"); gtag('js', new Date()); gtag('set', { 'page_location': 'https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/', }); }); </script> <script type="text/javascript"> /*global ga, gtag */ bizx.cmp.ifConsent('', ['all'], function () { gtag('config', 'G-1H226E4E4L', { send_page_view: false, 'SF_Page_Type': '', user_properties: { 'SF_Logged_in': 'Logged Out', }, 'devicePixelRatio': SF.devicePixelRatio, }); gtag('event', 'page_view', { send_to: 'G-1H226E4E4L' }); }); </script> </body> </html>