<commit_before>"""
This is a script to build the NetPyNE html documentation

All steps should be executed from netpyne/doc

The following are required:
1) Sphinx Documentation Generator: https://www.sphinx-doc.org/en/master/
2) Sphinx RTD Theme
3) Autodoc summary table: https://autodocsumm.readthedocs.io/en/latest/index.html

Which can be installed with:
python3 -m pip install -U sphinx
python3 -m pip install -U sphinx_rtd_theme
python3 -m pip install -U autodocsumm

Here are the steps to release a new version of NetPyNE
(step 10 is completed by executing this file):

1) Go through Pull Requests and merge acceptable ones into Development
2) Ensure all tests pass after the last commit
3) Ensure all new features are described in the documentation
4) Update CHANGES.md
5) Update the __init__.py version number
6) Update the version number in the Sphinx documentation (netpyne/doc/source/conf.py)
7) Commit with the message “VERSION #.#.#”
8) Create a Pull Request from Development to Master
    8a) Title it “PR from development to master - VERSION #.#.#”
    8b) Ensure the Pull Request passes all tests
    8c) Merge the Pull Request
9) Start a new Release on GitHub
    9a) Title it and tag it “v#.#.#”
    9b) Copy the text in CHANGES.md into the Release description
    9c) Publish the Release
10) Rebuild the documentation (execute build.py to accomplish these steps)
    10a) It will delete the old build directory
    10b) It will delete any old .rst files except those listed
    10c) It will generate new .rst files for the API (package index)
    10d) It will fix the Package Index file
    10e) It will build the html files
11) Post the documentation
    11a) ssh gkaue9v7ctjf@172.16.31.10 "rm -r ~/public_html"
    11b) scp -r build gkaue9v7ctjf@107.180.3.236:///home/gkaue9v7ctjf/public_html
    11c) ssh gkaue9v7ctjf@172.16.31.10 "cp -r ~/redirect_html/. ~/public_html/"
12) Update PYPI (pip) with the latest release
    12a) cd netpyne
    12b) python setup.py bdist_wheel --universal
    12c) python setup.py upload_via_twine
         Username: salvadord
13) Announce the new release<commit_msg>Added dependency information to build.py<commit_after>"""
This is a script to build the NetPyNE html documentation

All steps should be executed from netpyne/doc

The following are required:
1) Sphinx documentation generator: https://www.sphinx-doc.org/en/master/
2) Sphinx RTD Theme
3) Autodoc summary table: https://autodocsumm.readthedocs.io/en/latest/index.html
4) Wheel packager: https://wheel.readthedocs.io/en/stable/
5) Twine packager: https://twine.readthedocs.io/en/latest/

Which can be installed with:
python3 -m pip install -U sphinx
python3 -m pip install -U sphinx_rtd_theme
python3 -m pip install -U autodocsumm
python3 -m pip install -U wheel
python3 -m pip install -U twine

Here are the steps to release a new version of NetPyNE
(step 10 is completed by executing this file):

1) Go through Pull Requests and merge acceptable ones into Development
2) Ensure all tests pass after the last commit
3) Ensure all new features are described in the documentation
4) Update CHANGES.md
5) Update the __init__.py version number
6) Update the version number in the Sphinx documentation (netpyne/doc/source/conf.py)
7) Commit with the message “VERSION #.#.#”
8) Create a Pull Request from Development to Master
    8a) Title it “PR from development to master - VERSION #.#.#”
    8b) Ensure the Pull Request passes all tests
    8c) Merge the Pull Request
9) Start a new Release on GitHub
    9a) Title it and tag it “v#.#.#”
    9b) Copy the text in CHANGES.md into the Release description
    9c) Publish the Release
10) Rebuild the documentation (execute build.py to accomplish these steps)
    10a) It will delete the old build directory
    10b) It will delete any old .rst files except those listed
    10c) It will generate new .rst files for the API (package index)
    10d) It will fix the Package Index file
    10e) It will build the html files
11) Post the documentation
    11a) ssh gkaue9v7ctjf@172.16.31.10 "rm -r ~/public_html"
    11b) scp -r build gkaue9v7ctjf@172.16.31.10:///home/gkaue9v7ctjf/public_html
    11c) ssh gkaue9v7ctjf@172.16.31.10 "cp -r ~/redirect_html/. ~/public_html/"
12) Update PYPI (pip) with the latest release
    12a) cd netpyne
    12b) python3 setup.py bdist_wheel --universal
    12c) python setup.py upload_via_twine
         Username: salvadord
13) Announce the new release
{'fraction_non_alphanumeric': 0.07308297728805936, 'fraction_numerical': 0.040926467281313245, 'mean_word_length': 3.7319148936170214, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 6, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3975501', 'n_tokens_mistral': 1501, 'n_tokens_neox': 1410, 'n_words': 617}