|
| 1 | +================= |
| 2 | + Doctr Changelog |
| 3 | +================= |
| 4 | + |
| 5 | +Current |
| 6 | +======= |
| 7 | +- Invalid input won't kill ``doctr`` but will instead prompt again for valid |
| 8 | + input. Prevents users from having to go through the whole login rigamarole |
| 9 | + again. (:issue:`181`) |
| 10 | + |
| 11 | +1.5.3 (2017-04-07) |
| 12 | +================== |
| 13 | +- Fix for ``doctr configure`` crashing (:issue:`179`) |
| 14 | + |
| 15 | +1.5.2 (2017-03-29) |
| 16 | +================== |
| 17 | +- Fix for bug that prevented deploying using ``no-require-master`` |
| 18 | + |
| 19 | +1.5.1 (2017-03-17) |
| 20 | +================== |
| 21 | +- Fix for critical bug that allowed pushing docs from any branch. (:issue:`160`) |
| 22 | + |
| 23 | +1.5.0 (2017-03-15) |
| 24 | +================== |
| 25 | +- The ``--gh-pages-docs`` flag of ``doctr deploy`` has been deprecated. |
| 26 | + Specify the deploy directory like ``doctr deploy .`` or ``doctr deploy docs``. |
| 27 | + There is also no longer a default deploy directory. (:issue:`128`) |
| 28 | +- ``setup_GitHub_push`` now takes a ``branch_whitelist`` parameter instead of |
| 29 | + of a ``require_master`` |
| 30 | +- ``.travis.yml`` can be used to store some of doctr configuration in addition |
| 31 | + to the command line flags. Write doctr configuration under the ``doctr`` key. |
| 32 | + (:issue:`137`) |
| 33 | +- All boolean command line flags now have a counterpart that can overwrite |
| 34 | + the config values set in ``.travis.yml`` |
| 35 | +- ``doctr`` can now deploy to organization accounts (``github.io``) |
| 36 | + (:issue:`25`) |
| 37 | +- Added ``--deploy-branch-name`` flag to specify which branch docs will be |
| 38 | + deployed to |
| 39 | + |
| 40 | +1.4.1 (2017-01-11) |
| 41 | +================== |
| 42 | +- Fix Travis API endpoint when checking if a repo exists. (:issue:`143`) |
| 43 | +- Add warnings about needing ``set -e`` in ``.travis.yml``. (:issue:`146`) |
| 44 | +- Explicitly pull from ``doctr_remote`` on Travis. (:issue:`147`) |
| 45 | +- Don't attempt to push ``gh-pages`` to the remote when pushing is disallowed |
| 46 | + (e.g., on a pull request). (:issue:`150`) |
| 47 | +- ``doctr configure`` now deletes the public key automatically. (:issue:`151`) |
| 48 | + |
| 49 | +1.4.0 (2016-11-11) |
| 50 | +================== |
| 51 | + |
| 52 | +- Set the git ``user.email`` configuration option. This is now required by the |
| 53 | + latest versions of git. (:issue:`138`, :issue:`139`) |
| 54 | +- Add more information to the automated commit messages. (:issue:`134`) |
| 55 | +- Run doctr tests on Travis with a personal access token, avoiding rate |
| 56 | + limiting errors. (:issue:`133`) |
| 57 | +- Run all doctr steps except for the push on every build. Add ``--no-push`` |
| 58 | + option. Thanks @Carreau. (:issue:`125`, :issue:`126`, :issue:`132`) |
| 59 | +- Clarify in docs that doctr is not just for Sphinx. (:issue:`129`, |
| 60 | + :issue:`130`) |
| 61 | +- Use the latest version of sphinxcontrib.autoprogram to build the doctr docs. |
| 62 | + (:issue:`127`) |
| 63 | +- Check that the build repo exists on Travis. (:issue:`114`, :issue:`123`) |
| 64 | + |
| 65 | +1.3.3 (2016-09-20) |
| 66 | +================== |
| 67 | + |
| 68 | +- Add support for private GitHub repositories using travis-ci.com (thanks |
| 69 | + @dan-blanchard). (:issue:`121`) |
| 70 | +- Add a list of projects using doctr to the docs. (:issue:`116`) |
| 71 | +- Use the sphinx-issues extension in the changelog. (:issue:`99`) |
| 72 | +- Swap "description" and "long_description" in setup.py. (:issue:`120`) |
| 73 | + |
| 74 | +1.3.2 (2016-09-01) |
| 75 | +================== |
| 76 | + |
| 77 | +Major Changes |
| 78 | +------------- |
| 79 | + |
| 80 | +- Fix the --built-docs option. (:issue:`111`) |
| 81 | + |
| 82 | +Minor Changes |
| 83 | +------------- |
| 84 | + |
| 85 | +- Get the setup.py description from the README. (:issue:`103`) |
| 86 | +- Add link to GitHub docs for branch protection (thanks @willingc). (:issue:`100`) |
| 87 | + |
| 88 | +1.3.1 (2016-08-31) |
| 89 | +================== |
| 90 | + |
| 91 | +Major Changes |
| 92 | +------------- |
| 93 | + |
| 94 | +- Fix a bug that would cause doctr to fail if run on a pull request from a |
| 95 | + fork. (:issue:`101`) |
| 96 | + |
| 97 | +1.3 (2016-08-30) |
| 98 | +================ |
| 99 | + |
| 100 | +Major Changes |
| 101 | +------------- |
| 102 | + |
| 103 | +- Remove the ``--tmp-dir`` flag from the command line (doctr now always |
| 104 | + deploys using a log file). (:issue:`92`) |
| 105 | +- Python API: Change ``commit_docs`` to actually commit the docs (previously, |
| 106 | + it was done in ``push_docs``). (:issue:`92`) |
| 107 | +- Python API: Don't sync files or get the build dir in ``commit_docs``. This |
| 108 | + is done separately in ``__main__.py``. The Python API for ``commit_docs`` is |
| 109 | + now ``commit_docs(*, added, removed)``. (:issue:`92`) |
| 110 | +- Python API: ``sync_from_log`` automatically includes the log file in the list of added |
| 111 | + files. (:issue:`92`) |
| 112 | +- Support running doctr multiple times in the same build. (:issue:`93`, :issue:`95`) |
| 113 | +- Add ``doctr deploy --command`` to allow running a command before committing |
| 114 | + and deploying. (:issue:`97`) |
| 115 | +- Add ``doctr deploy --no-sync`` to allow disabling syncing (useful with |
| 116 | + ``doctr deploy --command``). (:issue:`97`) |
| 117 | + |
| 118 | +Minor Changes |
| 119 | +------------- |
| 120 | + |
| 121 | +- Correctly commit the log file. (:issue:`92`) |
| 122 | +- Fix sync_from_log to create dst if it doesn't exist, and add tests for this. (:issue:`92`) |
| 123 | +- Don't assume that doctr is being run from master when creating gh-pages. (:issue:`93`) |
| 124 | +- Return to the previous branch after deploying. (:issue:`93`) |
| 125 | +- Remove extra space before options in configure help text. (:issue:`90`) |
| 126 | + |
| 127 | +1.2 (2016-08-29) |
| 128 | +================ |
| 129 | + |
| 130 | +Major Changes |
| 131 | +------------- |
| 132 | +- Allow ``--gh-pages-docs .`` (deploying to the root directory of the |
| 133 | + ``gh-pages`` branch). (:issue:`73`) |
| 134 | +- Allow deploying to a separate repo (via ``doctr deploy --deploy-repo <repo>``). (:issue:`63`) |
| 135 | +- Automatically detect Sphinx build directory. (:issue:`6`) |
| 136 | +- Add ``--no-require-master`` flag to allow pushing from branches other than master. (:issue:`70`) |
| 137 | + |
| 138 | +Minor Changes |
| 139 | +------------- |
| 140 | +- Add a GitHub banner to the docs. (:issue:`64`) |
| 141 | +- Move to the GitHub organization `drdoctr <https://github.com/drdoctr>`_. (:issue:`67`) |
| 142 | +- Check if user/org and repo are valid before generating ssh keys or pinging Travis. (:issue:`87`) |
| 143 | +- Various improvements to documentation. |
| 144 | +- Various improvements to error checking. |
| 145 | + |
| 146 | +1.1.1 (2016-08-09) |
| 147 | +================== |
| 148 | + |
| 149 | +Minor Changes |
| 150 | +------------- |
| 151 | + |
| 152 | +- Add installation instructions to the documentation. (:issue:`60`) |
| 153 | +- Fix some lingering "Travis docs builder" -> "Doctr", including in the git |
| 154 | + attributes on Travis. (:issue:`60`) |
| 155 | +- Better error message when the repo doesn't exist in doctr configure. (:issue:`59`) |
| 156 | +- Indicate that repo should be org/reponame in doctr configure. (:issue:`59`) |
| 157 | + |
| 158 | +1.1 (2016-08-09) |
| 159 | +================ |
| 160 | + |
| 161 | +Major Changes |
| 162 | +------------- |
| 163 | + |
| 164 | +- Add a real command line interface with argparse. (:issue:`23`) |
| 165 | +- Split the command line into ``doctr configure`` and ``doctr deploy``. (:issue:`28`) |
| 166 | +- Add support for using GitHub deploy keys (now the default) (:issue:`30`) |
| 167 | + |
| 168 | +Minor Changes |
| 169 | +------------- |
| 170 | + |
| 171 | +- Add flags to ``doctr deploy`` to change the build and deploy locations of |
| 172 | + the docs. (:issue:`52`) |
| 173 | +- Print more helpful instructions from ``doctr configure``. (:issue:`46`) |
| 174 | +- Add more documentation. (:issue:`47`) |
| 175 | + |
| 176 | +1.0 (2016-07-22) |
| 177 | +================ |
| 178 | + |
| 179 | +Major Changes |
| 180 | +------------- |
| 181 | + |
| 182 | +- First release. Basic support for configuring doctr to push to Travis (using |
| 183 | + a token) and deploying to gh-pages from Travis. |
0 commit comments