Skip to content

Commit

Permalink
Removed build_webdocs.py
Browse files Browse the repository at this point in the history
Artifact from the past. (back in Web Docs Iteration #2 - internal repo)
  • Loading branch information
ben-albrecht committed Sep 18, 2015
1 parent f5ee342 commit bdab37a
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 262 deletions.
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ tags
/doc/tutorial/workbooks/*.dvi
/doc/tutorial/workbooks/*.bbl
/doc/tutorial/workbooks/*.blg
/doc/source/sphinx/*.rst
!/doc/source/sphinx/index.rst
/doc/sphinx/build
/doc/sphinx/source/*.rst
/doc/sphinx/source/platforms/*.rst
!/doc/sphinx/source/platforms/index.rst
/doc/sphinx/source/technotes/*.rst
/doc/sphinx/source/modules
!/doc/sphinx/source/index.rst
!/doc/sphinx/source/technotes/index.rst
/doc/sphinx/build
!/doc/sphinx/source/platforms/index.rst


# Make ignores.
Expand Down
9 changes: 5 additions & 4 deletions doc/release/README.bugs → doc/release/README.bugs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,16 @@ in confidence by the Chapel team, please mail it to:
Please include as much information as possible in your email. For
example:

* the Chapel program that caused the problem (if possible and applicable)
* the behavior you are seeing
* the output of the $CHPL_HOME/util/printchplenv script
* the version number of your Chapel compiler (chpl --version)
* the output of the ``$CHPL_HOME/util/printchplenv`` script
* the output of ``module list`` (when applicable)
* the version number of your Chapel compiler (``chpl --version``)
* the platform(s) you are running on and their OS versions
* the C/C++ compiler(s) you are using and their versions
* the Chapel program that caused the problem (if possible)

A list of unimplemented features and known bugs can be found in
$CHPL_HOME/STATUS. Feel free to check any unexpected behavior against
``$CHPL_HOME/STATUS``. Feel free to check any unexpected behavior against
this file. Even if you run into a known issue, we encourage you to
email us a bug report to make us aware that it's a problem for your
code. We are more than happy to suggest workarounds and/or to
Expand Down
206 changes: 0 additions & 206 deletions doc/sphinx/build_webdocs.py

This file was deleted.

33 changes: 0 additions & 33 deletions doc/sphinx/source/bugs.rst

This file was deleted.

1 change: 1 addition & 0 deletions doc/sphinx/source/bugs.rst
21 changes: 6 additions & 15 deletions doc/sphinx/symlinks.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@
from __future__ import print_function

import os
import sys
import shlex
import shutil

from subprocess32 import Popen, PIPE
from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter


def extfilter(directory, extension='.rst'):
Expand All @@ -18,10 +12,7 @@ def extfilter(directory, extension='.rst'):


def main():
"""TODO: Docstring for main.
:returns: TODO
"""
"""symlinks doc/release/* to doc/sphinx/source/ for *rst files"""

# Check that $CHPL_HOME is defined, and set the path to a variable
chpl_home = os.getenv('CHPL_HOME')
Expand All @@ -35,13 +26,13 @@ def main():

# Create list of READMEs converted to rst
docs = {}
docs['.'] = extfilter(os.path.join(chpl_home, 'doc/release'))
docs['platforms'] = extfilter(os.path.join(chpl_home, 'doc/release/platforms'))
docs['technotes'] = extfilter(os.path.join(chpl_home, 'doc/release/technotes'))
docs['source'] = extfilter(os.path.join(chpl_home, 'doc/release'))
docs['source/platforms'] = extfilter(os.path.join(chpl_home, 'doc/release/platforms'))
docs['source/technotes'] = extfilter(os.path.join(chpl_home, 'doc/release/technotes'))

# Copy READMEs into webdocs/source/{directory} with new names
# symlink READMEs into doc/sphinx
for directory, rstfiles in docs.items():
newdir = os.path.join(sourcedir, directory)
newdir = os.path.join(filedir, directory)
for rstfile in rstfiles:
# strip off README. prefix
newrstfilename = os.path.split(rstfile)[1].replace('README.', '')
Expand Down

0 comments on commit bdab37a

Please sign in to comment.