├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.org ├── autodoc.sh ├── bin └── build_docs ├── doc └── source.org ├── generate_docs └── update_version.sh /.gitignore: -------------------------------------------------------------------------------- 1 | gh-pages 2 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # v0011 - 2017-12-12 2 | - Make script output nicer (colors!) 3 | - Self-host autodoc docs 4 | 5 | # v0008 - 2017-12-12 6 | 7 | - Check exit status of the executed command 8 | - Exit early if the command returned no output 9 | - Added banner and version info 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: autodoc 2 | #+HTML_HEAD: 3 | #+HTML_HEAD: 4 | #+HTML_HEAD: 5 | #+HTML_HEAD: 6 | #+HTML_HEAD: 7 | #+HTML_HEAD: 8 | 9 | [[https://plexus.github.io/autodoc/][Autodoc docs]] 10 | 11 | Automate the publishing of generated docs. 12 | 13 | Imagine the following scenario: you have files in a git repo, from which you generate HTML, which you want to make available on-line. 14 | 15 | For example: you have source code from which you generate API docs, or you have markdown files that you run through a static site generator. 16 | 17 | If you're using Github then getting these resulting files on-line is as easy as pushing to the ~gh-pages~ branch. This isn't hard, but you have to first generate the HTML, put it aside, switch branches, commit the change, push it to Github, and switch back. There are many little things that can go wrong in that process. It's also few minutes of your life that you just wasted doing a tedious, mechanical job, every time again. 18 | 19 | Enter ~autodoc~, a single shell script that automates this process as best as it can. 20 | 21 | * Installation 22 | 23 | The recommended, "evergreen" way of using ~autodoc~ is to create a small shell script in your repository, you can call it ~generate_docs~, that looks like this: 24 | 25 | #+BEGIN_SRC shell 26 | #!/bin/bash 27 | 28 | # Command that generates the HTML. 29 | export AUTODOC_CMD="lein codox" 30 | 31 | # The directory where the result of $AUTODOC_CMD, the generated HTML, ends up. This 32 | # is what gets committed to $AUTODOC_BRANCH. 33 | # export AUTODOC_DIR="gh-pages" 34 | 35 | # You can optionally keep multiple versions of your documentation in a 36 | # subdirectory of AUTODOC_DIR. If you set this variable then the 37 | # generated HTML is expected to go into this subdirectory, and the contents 38 | # of any other subdirectories are preserved. 39 | # export AUTODOC_SUBDIR="v0.1.0" 40 | 41 | # The git remote to fetch from and push to. 42 | # export AUTODOC_REMOTE="origin" 43 | 44 | # Branch name to commit and push to 45 | # export AUTODOC_BRANCH="gh-pages" 46 | 47 | \curl -sSL https://raw.githubusercontent.com/plexus/autodoc/master/autodoc.sh | bash 48 | #+END_SRC 49 | 50 | At a minimum you must set ~AUTODOC_CMD~, this is the command that gets called to generate the HTML files. 51 | 52 | If you're not comfortable running a shell script straight off the internets, you 53 | can also just copy ~autodoc.sh~ to your project, and change the variables at the 54 | top of the script. 55 | 56 | * Usage instructions 57 | 58 | Call ~./generate_docs~ at any time, and the HTML will immediately be updated and made available on-line. This is safe to do no matter the state of your repository. More on why that is below. 59 | 60 | The other variables are optional, the values you see in the script above are their defaults. 61 | 62 | You can have local changes, untracked files, files in the staging area, etc. The script does not actually switch branches, and does not change the current "working tree" beyond running ~$AUTODOC_CMD~. 63 | 64 | **DO WATCH OUT:** The ~$AUTODOC_DIR~ directory will be removed and re-created on every run. It should only contain generated artifacts, and should be in your ~.gitignore~. If you point this to your homework then it will eat your homework. 65 | 66 | * How it works 67 | 68 | The procedure that ~autodoc~ follows has been tweaked over time to be as reliable and fool proof as possible. Here is roughly what it does, in order. 69 | 70 | - Check if ~$AUTODOC_CMD~ is set, otherwise exit 71 | - Do a ~git fetch~, to know what the target branch looks like on the remote (e.g. ~origin/gh-pages~) 72 | - Clear out ~$AUTODOC_DIR~. It deletes it if already there, and then creates it anew, to make sure you don't commit stale files. 73 | - Run ~$AUTODOC_CMD~. This should put the HTML artifacts in ~$AUTODOC_DIR~ 74 | - Check if ~$AUTODOC_DIR~ is empty. If so then the command didn't create any output, and the script will complain and exit. 75 | - Create a git "tree object" of the contents of ~$AUTODOC_DIR~. If ~$AUTODOC_SUBDIR~ is set, then any docs that were previously generated to other subdirs are also merged into the tree. 76 | - Generate a commit message which includes the source branch and commit hash, as well as an overview of any local changes 77 | - Create a git "commit object" with this tree and message, and with as parent commit the latest commit on the target branch on the target remote, or as an orphan commit if the target branch does not yet exist. 78 | - Check if the created commit differs from its parent. If not then there was no change and the script exits. 79 | - Push this commit to ~AUTODOC_REMOTE/AUTODOC_BRANCH~ (e.g. ~origin/gh-pages~) 80 | - Display the commit with diff stats so you get some feedback on what happened 81 | 82 | * Generating API docs 83 | 84 | ~autodoc~ is really a cry to library maintainers across continents and languages: please publish API docs. Here I'll try to collect some quick tips on how to do that. Please add your favorite language and tool, each section should be a concise summary on how to get started, plus links to the tool's documentation. 85 | 86 | If this was wikipedia this part would be called a stub. Do dive in! 87 | 88 | ** Clojure 89 | 90 | The main tool you're looking for is [[https://github.com/weavejester/codox][codox]], although [[https://github.com/gdeer81/marginalia][Marginalia]] could also be of use. 91 | 92 | - example [[https://github.com/lambdaisland/uri/blob/master/project.clj][using Leiningen]] 93 | - example [[https://github.com/martinklepsch/derivatives/blob/1f4cc704dec11be301b790e204fc90c7fe18b293/build.boot#L48-L51][using boot]] 94 | 95 | Use ~DOC_CMD="lein codox"~ or ~DOC_CMD="boot codox target"~. 96 | 97 | * Improving autodoc 98 | 99 | This script has already seen a few iterations of polish, but it can without a doubt be further improved. It needs to be reliable and safe, either doing its job, or bailing out and telling the user what the problem is. 100 | 101 | If you can make it more reliable and safe then it currently is, then we'd love to get a pull request. 102 | 103 | * Projects using autodoc 104 | 105 | * Credits 106 | 107 | Initially written by [[https://twitter.com/plexus][Arne Brasseur]], improved with the help of [[http://twitter.com/martinklepsch/][Martin Klepsch]] and [[http://twitter.com/jackrusher/][Jack Rusher]] 108 | 109 | * License 110 | 111 | Copyright © Arne Brasseur and contributors 112 | 113 | Available under the Mozilla Public License 2.0. See ~LICENSE~. 114 | 115 | # These are included in the built docs, but are not visible on the Github 116 | # project page 117 | 118 | #+INCLUDE: "doc/source.org" :minlevel 1 119 | -------------------------------------------------------------------------------- /autodoc.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Keep a separate branch of generated API docs. 4 | # 5 | # This script generates API documentation, commits it to a separate branch, and 6 | # pushes it upstream. It does this without actually checking out the branch, 7 | # using a separate working tree directory, so without any disruption to your 8 | # current working tree. You can have local file modifications, and/or files in 9 | # the staging area, but be warned it will be difficult to track the origin 10 | # of your documentation if the tree isn't committed. 11 | 12 | ############################################################ 13 | # These variables can all be overridden from the command line, 14 | # e.g. AUTODOC_REMOTE=plexus ./generate_docs 15 | 16 | # The git remote to fetch and push to. Also used to find the parent commit. 17 | AUTODOC_REMOTE=${AUTODOC_REMOTE:-"origin"} 18 | 19 | # Branch name to commit and push to 20 | AUTODOC_BRANCH=${AUTODOC_BRANCH:-"gh-pages"} 21 | 22 | # Command that generates the API docs 23 | #AUTODOC_CMD=${AUTODOC_CMD:-"lein with-profile +codox codox"} 24 | #AUTODOC_CMD=${AUTODOC_CMD:-"boot codox -s src -n my-project -o gh-pages target"} 25 | 26 | # Working tree directory. The output of $AUTODOC_CMD must end up in this directory. 27 | AUTODOC_DIR=${AUTODOC_DIR:-"gh-pages"} 28 | 29 | # Working tree subdirectory. This is for situations where the caller 30 | # wishes to preserve multiple versions of the documentation. When 31 | # non-empty then the output of $AUTODOC_CMD must end up in 32 | # $AUTODOC_DIR/$AUTODOC_SUBDIR 33 | AUTODOC_SUBDIR=${AUTODOC_SUBDIR:-""} 34 | 35 | ############################################################ 36 | 37 | function echo_info() { 38 | echo -en "[\033[0;32mautodoc\033[0m] " 39 | echo $* 40 | } 41 | 42 | function echo_error() { 43 | echo -en "[\033[0;31mautodoc\033[0m] " 44 | echo $* 45 | } 46 | 47 | if [[ -z "$AUTODOC_CMD" ]]; then 48 | echo_error "Please specify a AUTODOC_CMD, e.g. lein codox" 49 | exit 1 50 | fi 51 | 52 | VERSION=0022 53 | 54 | echo "//======================================\\\\" 55 | echo "|| AUTODOC v${VERSION} ||" 56 | echo "\\\\======================================//" 57 | 58 | MESSAGE="Updating docs ($AUTODOC_DIR/$AUTODOC_SUBDIR) from commit $(git rev-parse --short HEAD) on branch $(git rev-parse --abbrev-ref HEAD) 59 | 60 | Ran: $AUTODOC_CMD 61 | " 62 | 63 | if [[ ! -z "$(git status --porcelain)" ]]; then 64 | MESSAGE="$MESSAGE 65 | Repo not clean. 66 | 67 | Status: 68 | $(git status --short) 69 | 70 | Diff: 71 | $(git diff)" 72 | fi 73 | 74 | # Fetch the remote. We don't care about local branches, only about 75 | # what's currently on the remote. Using the explicit "+refs/heads/..." 76 | # syntax like this looks overly complicated but is necessary in CI 77 | # environments like Travis CI where only the specific branch of the 78 | # repo is cloned. 79 | git fetch $AUTODOC_REMOTE "+refs/heads/${AUTODOC_BRANCH}:refs/remotes/${AUTODOC_REMOTE}/${AUTODOC_BRANCH}" 80 | 81 | # Start from a clean slate, we only commit the new output of AUTODOC_CMD, nothing else. 82 | rm -rf $AUTODOC_DIR 83 | mkdir -p $AUTODOC_DIR 84 | 85 | echo_info "Generating docs" 86 | echo $AUTODOC_CMD | bash 87 | 88 | AUTODOC_RESULT=$? 89 | 90 | if [[ ! $AUTODOC_RESULT -eq 0 ]]; then 91 | echo_error "The command '${AUTODOC_CMD}' returned a non-zero exit status (${AUTODOC_RESULT}), giving up." 92 | exit $AUTODOC_RESULT 93 | fi 94 | 95 | # Confirm there is new output in the specified dir 96 | if [[ -z "$AUTODOC_SUBDIR" ]]; then 97 | if [[ $(find $AUTODOC_DIR -maxdepth 0 -type d -empty 2>/dev/null) ]]; then 98 | echo_error "The command '$AUTODOC_CMD' created no output in '$AUTODOC_DIR', giving up" 99 | exit 1 100 | fi 101 | else 102 | if [[ $(find $AUTODOC_DIR/$AUTODOC_SUBDIR -maxdepth 0 -type d -empty 2>/dev/null) ]]; then 103 | echo_error "The command '$AUTODOC_CMD' created no output in '$AUTODOC_DIR/$AUTODOC_SUBDIR', giving up" 104 | exit 1 105 | fi 106 | fi 107 | 108 | # Create a temp dir 109 | AUTODOC_TMP=$(mktemp -d /tmp/autodoc.XXXXXXXX) 110 | AUTODOC_RESULT=$? 111 | if [[ ! $AUTODOC_RESULT -eq 0 ]]; then 112 | echo_error "mktemp returned a non-zero exit status (${AUTODOC_RESULT}), giving up." 113 | exit $AUTODOC_RESULT 114 | fi 115 | 116 | # Use a temp index to construct the tree to commit 117 | export GIT_INDEX_FILE=$AUTODOC_TMP/index 118 | 119 | # Determine the parent commit (if any) on AUTODOC_BRANCH 120 | if git show-ref --quiet --verify "refs/remotes/${AUTODOC_REMOTE}/${AUTODOC_BRANCH}" ; then 121 | PARENT=`git rev-parse ${AUTODOC_REMOTE}/${AUTODOC_BRANCH}` 122 | fi 123 | 124 | # Prepare index 125 | if [[ ! -z "$AUTODOC_SUBDIR" && ! -z "$PARENT" ]]; then 126 | # If there is a parent commit on AUTODOC_BRANCH, and we're 127 | # preserving other subdirs, then we need to read-tree the previous 128 | # state of AUTODOC_DIR 129 | echo_info "Reading tree from parent commit" 130 | PARENT_TREE=`git rev-parse $PARENT^{tree}` 131 | git read-tree $PARENT_TREE 132 | # We remove any remnant of the last subdir from the index 133 | git rm --cached -r $AUTODOC_SUBDIR 134 | # Add in the current generated docs 135 | echo_info "Merging new docs into git index" 136 | git --work-tree=$AUTODOC_DIR add --no-all . 137 | else 138 | # If we're not preserving subdirs or we don't have a parent then 139 | # the full output of AUTODOC_CMD is added to the git index, staged 140 | # to become a new file tree+commit 141 | echo_info "Adding docs to git index" 142 | git --work-tree=$AUTODOC_DIR add -A 143 | fi 144 | 145 | # Write the git tree with the exact contents of index. 146 | TREE=`git write-tree` 147 | echo_info "Created git tree $TREE" 148 | 149 | # Create the new commit, either with the previous remote HEAD as parent, or as a 150 | # new orphan commit 151 | if [[ ! -z "$PARENT" ]]; then 152 | echo_info "Creating commit with parent refs/remotes/${AUTODOC_REMOTE}/${AUTODOC_BRANCH} ${PARENT}" 153 | COMMIT=$(git commit-tree -p $PARENT $TREE -m "$MESSAGE") 154 | else 155 | echo_info "Creating first commit of the branch" 156 | COMMIT=$(git commit-tree $TREE -m "$MESSAGE") 157 | fi 158 | 159 | # Restore the original git index and clean up the temp dir 160 | unset GIT_INDEX_FILE 161 | rm -rf $AUTODOC_TMP 162 | 163 | echo_info "Pushing $COMMIT to $AUTODOC_BRANCH" 164 | 165 | # Push the newly created commit to remote 166 | if [[ ! -z "$PARENT" ]] && [[ $(git rev-parse ${COMMIT}^{tree}) == $(git rev-parse refs/remotes/$AUTODOC_REMOTE/$AUTODOC_BRANCH^{tree} ) ]] ; then 167 | echo_error "WARNING: No changes in documentation output from previous commit. Not pushing to ${AUTODOC_BRANCH}" 168 | else 169 | git push $AUTODOC_REMOTE $COMMIT:refs/heads/$AUTODOC_BRANCH 170 | # Make sure our local remotes are up to date. 171 | git fetch 172 | # Show what happened, you should see a little stat diff here of the changes 173 | echo 174 | git log -1 --stat $AUTODOC_REMOTE/$AUTODOC_BRANCH 175 | fi 176 | -------------------------------------------------------------------------------- /bin/build_docs: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set +e 4 | 5 | cd gh-pages 6 | 7 | wget -q https://www.pirilampo.org/styles/readtheorg/css/htmlize.css 8 | wget -q https://www.pirilampo.org/styles/readtheorg/css/readtheorg.css 9 | wget -q https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js 10 | wget -q https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js 11 | wget -q https://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.min.js 12 | wget -q https://www.pirilampo.org/styles/readtheorg/js/readtheorg.js 13 | 14 | emacsclient -e '(with-current-buffer (find-file-noselect "'`pwd`'/../README.org") (org-html-export-to-html))' 15 | 16 | mv ../README.html index.html -------------------------------------------------------------------------------- /doc/source.org: -------------------------------------------------------------------------------- 1 | * Source 2 | 3 | #+INCLUDE: "../autodoc.sh" src shell 4 | -------------------------------------------------------------------------------- /generate_docs: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | AUTODOC_CMD="bin/build_docs" 4 | 5 | . autodoc.sh -------------------------------------------------------------------------------- /update_version.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # this is used as a pre-commit hook, the version is just the number of commits on master 4 | 5 | cp autodoc.sh /tmp 6 | sed "s/VERSION=.*/$(printf "VERSION=%04d" `git rev-list --count HEAD`)/" /tmp/autodoc.sh > autodoc.sh 7 | git add autodoc.sh 8 | --------------------------------------------------------------------------------