Hi all, A while back I set up an account with Read the Docs, a free service for converting reStructuredText documents to HTML and PDF using Sphinx, and for hosting these files online. I currently keep the source files at https://github.com/rmzelle/writing, with the rendered documentation available at docs.citationstyles.org. So far it hosts our documentation on locale files, and a rewritten version of the CSL primer.
I'm now considering migrating all long-form CSL documentation from citationstyles.org/downloads/... to docs.citationstyles.org. This would affect the CSL specification, primer, and release notes. Unless people suggest otherwise, I'm planning to: - move the existing source files at https://github.com/rmzelle/writing to https://github.com/citation-style-language/documentation. - adapt the existing source files at https://github.com/citation-style-language/documentation for rendering through Read the Docs. This move would have several advantages: * http://citationstyles.org/downloads/specification.html is currently generated with https://bitbucket.org/fbennett/rst4csl, a custom Python script Frank wrote. So far, I always had to run the script locally, and upload the generated HTML to citationstyles.org by hand. In contrast, Read the Docs offers GitHub integration, so documentation is automatically regenerated after every commit. * the "/downloads/" path was always a bit weird. http://docs.citationstyles.org/... is much nicer. * Read the Docs has support for GitHub branches, so we could offer rendered versions for each CSL release, and the master development branch. The main drawback is that we're stuck with long URLs like http://docs.citationstyles.org/en/latest/primer.html. The alternative is giving up branch support, which would shorten the URLs to http://docs.citationstyles.org/primer.html (see https://docs.readthedocs.org/en/latest/single_version.html). Best, Rintze ------------------------------------------------------------------------------ _______________________________________________ xbiblio-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/xbiblio-devel
