Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation overhaul #3613

Closed
wants to merge 2 commits into from
Closed

Documentation overhaul #3613

wants to merge 2 commits into from

Conversation

TheBB
Copy link
Contributor

@TheBB TheBB commented Oct 31, 2015

See #3604 for backstory.

What this PR does:

  • Changes all links from org format to github format. This means that reading the docs on github is useless.
  • Leaves toc-org enabled on the assumption that it is still useful for reading in Emacs. This may not be the case (org has its own facilities for navigating large files).
  • Adds a file called core-documentation.el which is not loaded by default on the assumption that this is something that very few people will do and not very often. This file contains:
    • a function spacemacs//generate-layers-file which generates a file layers/LAYERS.org with a listing of all the layers.
    • a function spacemacs/publish-doc which exports all the relevant documentation to doc/export/ in the form of HTML files. This function automatically calls spacemacs//generate-layers-file.

The contents of the export directory should then be sent to the gh-pages branch somehow. This is not automatic yet.

I might make a Makefile target for this in the future.

@TheBB TheBB force-pushed the readthedocs branch 2 times, most recently from 8c51421 to aa69012 Compare October 31, 2015 09:50
@TheBB TheBB mentioned this pull request Oct 31, 2015
@syl20bnr
Copy link
Owner

syl20bnr commented Nov 2, 2015

Thank you ! Beautiful PR ❤️
Cherry-picked into develop branch, you can safely delete your branch.

@syl20bnr syl20bnr closed this Nov 2, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants