From bb8dca5b88a505adafe969de28a3d4781664ab79 Mon Sep 17 00:00:00 2001 From: Peter Vlugter Date: Wed, 20 Apr 2011 18:02:11 +1200 Subject: [PATCH] Try reorganised docs --- akka-docs/Makefile | 2 +- akka-docs/{ => _sphinx}/exts/includecode.py | 0 akka-docs/{ => _sphinx}/pygments/setup.py | 0 .../{ => _sphinx}/pygments/styles/__init__.py | 0 .../{ => _sphinx}/pygments/styles/simple.py | 0 .../{_static => _sphinx/static}/akka.png | Bin .../{_static => _sphinx/static}/logo.png | Bin .../{ => _sphinx}/themes/akka/layout.html | 0 .../themes/akka/static/akka.css_t | 0 .../themes/akka/static/alert_info_32.png | Bin .../themes/akka/static/alert_warning_32.png | Bin .../themes/akka/static/bg-page.png | Bin .../themes/akka/static/bullet_orange.png | Bin .../{ => _sphinx}/themes/akka/theme.conf | 0 akka-docs/conf.py | 10 +-- akka-docs/index.rst | 73 +----------------- akka-docs/{manual => intro}/building-akka.rst | 0 akka-docs/{manual => intro}/configuration.rst | 0 akka-docs/{manual => intro}/examples/Pi.scala | 0 .../getting-started-first-java.rst | 0 .../getting-started-first-scala.rst | 0 .../getting-started-first.rst | 0 akka-docs/intro/index.rst | 11 +++ akka-docs/{manual => intro}/pi-formula.png | Bin akka-docs/{manual => intro}/why-akka.rst | 0 akka-docs/manual/more.png | Bin 1502 -> 0 bytes .../actors-scala.rst => scala/actors.rst} | 4 +- .../{manual/fsm-scala.rst => scala/fsm.rst} | 0 akka-docs/scala/index.rst | 8 ++ 29 files changed, 29 insertions(+), 79 deletions(-) rename akka-docs/{ => _sphinx}/exts/includecode.py (100%) rename akka-docs/{ => _sphinx}/pygments/setup.py (100%) rename akka-docs/{ => _sphinx}/pygments/styles/__init__.py (100%) rename akka-docs/{ => _sphinx}/pygments/styles/simple.py (100%) rename akka-docs/{_static => _sphinx/static}/akka.png (100%) rename akka-docs/{_static => _sphinx/static}/logo.png (100%) rename akka-docs/{ => _sphinx}/themes/akka/layout.html (100%) rename akka-docs/{ => _sphinx}/themes/akka/static/akka.css_t (100%) rename akka-docs/{ => _sphinx}/themes/akka/static/alert_info_32.png (100%) rename akka-docs/{ => _sphinx}/themes/akka/static/alert_warning_32.png (100%) rename akka-docs/{ => _sphinx}/themes/akka/static/bg-page.png (100%) rename akka-docs/{ => _sphinx}/themes/akka/static/bullet_orange.png (100%) rename akka-docs/{ => _sphinx}/themes/akka/theme.conf (100%) rename akka-docs/{manual => intro}/building-akka.rst (100%) rename akka-docs/{manual => intro}/configuration.rst (100%) rename akka-docs/{manual => intro}/examples/Pi.scala (100%) rename akka-docs/{manual => intro}/getting-started-first-java.rst (100%) rename akka-docs/{manual => intro}/getting-started-first-scala.rst (100%) rename akka-docs/{manual => intro}/getting-started-first.rst (100%) create mode 100644 akka-docs/intro/index.rst rename akka-docs/{manual => intro}/pi-formula.png (100%) rename akka-docs/{manual => intro}/why-akka.rst (100%) delete mode 100644 akka-docs/manual/more.png rename akka-docs/{pending/actors-scala.rst => scala/actors.rst} (99%) rename akka-docs/{manual/fsm-scala.rst => scala/fsm.rst} (100%) create mode 100644 akka-docs/scala/index.rst diff --git a/akka-docs/Makefile b/akka-docs/Makefile index 7b803258cb..49f649367f 100644 --- a/akka-docs/Makefile +++ b/akka-docs/Makefile @@ -8,7 +8,7 @@ PAPER = BUILDDIR = _build EASYINSTALL = easy_install LOCALPACKAGES = $(shell pwd)/$(BUILDDIR)/site-packages -PYGMENTSDIR = pygments +PYGMENTSDIR = _sphinx/pygments # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 diff --git a/akka-docs/exts/includecode.py b/akka-docs/_sphinx/exts/includecode.py similarity index 100% rename from akka-docs/exts/includecode.py rename to akka-docs/_sphinx/exts/includecode.py diff --git a/akka-docs/pygments/setup.py b/akka-docs/_sphinx/pygments/setup.py similarity index 100% rename from akka-docs/pygments/setup.py rename to akka-docs/_sphinx/pygments/setup.py diff --git a/akka-docs/pygments/styles/__init__.py b/akka-docs/_sphinx/pygments/styles/__init__.py similarity index 100% rename from akka-docs/pygments/styles/__init__.py rename to akka-docs/_sphinx/pygments/styles/__init__.py diff --git a/akka-docs/pygments/styles/simple.py b/akka-docs/_sphinx/pygments/styles/simple.py similarity index 100% rename from akka-docs/pygments/styles/simple.py rename to akka-docs/_sphinx/pygments/styles/simple.py diff --git a/akka-docs/_static/akka.png b/akka-docs/_sphinx/static/akka.png similarity index 100% rename from akka-docs/_static/akka.png rename to akka-docs/_sphinx/static/akka.png diff --git a/akka-docs/_static/logo.png b/akka-docs/_sphinx/static/logo.png similarity index 100% rename from akka-docs/_static/logo.png rename to akka-docs/_sphinx/static/logo.png diff --git a/akka-docs/themes/akka/layout.html b/akka-docs/_sphinx/themes/akka/layout.html similarity index 100% rename from akka-docs/themes/akka/layout.html rename to akka-docs/_sphinx/themes/akka/layout.html diff --git a/akka-docs/themes/akka/static/akka.css_t b/akka-docs/_sphinx/themes/akka/static/akka.css_t similarity index 100% rename from akka-docs/themes/akka/static/akka.css_t rename to akka-docs/_sphinx/themes/akka/static/akka.css_t diff --git a/akka-docs/themes/akka/static/alert_info_32.png b/akka-docs/_sphinx/themes/akka/static/alert_info_32.png similarity index 100% rename from akka-docs/themes/akka/static/alert_info_32.png rename to akka-docs/_sphinx/themes/akka/static/alert_info_32.png diff --git a/akka-docs/themes/akka/static/alert_warning_32.png b/akka-docs/_sphinx/themes/akka/static/alert_warning_32.png similarity index 100% rename from akka-docs/themes/akka/static/alert_warning_32.png rename to akka-docs/_sphinx/themes/akka/static/alert_warning_32.png diff --git a/akka-docs/themes/akka/static/bg-page.png b/akka-docs/_sphinx/themes/akka/static/bg-page.png similarity index 100% rename from akka-docs/themes/akka/static/bg-page.png rename to akka-docs/_sphinx/themes/akka/static/bg-page.png diff --git a/akka-docs/themes/akka/static/bullet_orange.png b/akka-docs/_sphinx/themes/akka/static/bullet_orange.png similarity index 100% rename from akka-docs/themes/akka/static/bullet_orange.png rename to akka-docs/_sphinx/themes/akka/static/bullet_orange.png diff --git a/akka-docs/themes/akka/theme.conf b/akka-docs/_sphinx/themes/akka/theme.conf similarity index 100% rename from akka-docs/themes/akka/theme.conf rename to akka-docs/_sphinx/themes/akka/theme.conf diff --git a/akka-docs/conf.py b/akka-docs/conf.py index f0dd997167..209f747afc 100644 --- a/akka-docs/conf.py +++ b/akka-docs/conf.py @@ -7,7 +7,7 @@ import sys, os # -- General configuration ----------------------------------------------------- -sys.path.append(os.path.abspath('exts')) +sys.path.append(os.path.abspath('_sphinx/exts')) extensions = ['sphinx.ext.todo', 'includecode'] templates_path = ['_templates'] @@ -31,13 +31,13 @@ html_theme = 'akka' html_theme_options = { 'full_logo': 'true' } -html_theme_path = ['themes'] +html_theme_path = ['_sphinx/themes'] html_title = 'Akka Documentation' -html_logo = '_static/logo.png' +html_logo = '_sphinx/static/logo.png' #html_favicon = None -html_static_path = ['_static'] +html_static_path = ['_sphinx/static'] html_last_updated_fmt = '%b %d, %Y' #html_sidebars = {} @@ -65,4 +65,4 @@ latex_elements = { 'preamble': '\\definecolor{VerbatimColor}{rgb}{0.935,0.935,0.935}' } -# latex_logo = '_static/akka.png' +# latex_logo = '_sphinx/static/akka.png' diff --git a/akka-docs/index.rst b/akka-docs/index.rst index 7a4301de34..9a57f097e2 100644 --- a/akka-docs/index.rst +++ b/akka-docs/index.rst @@ -4,78 +4,9 @@ Contents .. toctree:: :maxdepth: 2 - manual/why-akka - manual/getting-started-first-scala - manual/getting-started-first-java - manual/building-akka - manual/configuration - manual/fsm-scala + intro/index + scala/index -.. pending/actor-registry-java -.. pending/actor-registry-scala -.. pending/actors-scala -.. pending/agents-scala -.. pending/articles -.. pending/benchmarks -.. pending/buildr -.. pending/cluster-membership -.. pending/companies-using-akka -.. pending/dataflow-java -.. pending/dataflow-scala -.. pending/deployment-scenarios -.. pending/developer-guidelines -.. pending/dispatchers-java -.. pending/dispatchers-scala -.. pending/event-handler -.. pending/external-sample-projects -.. pending/fault-tolerance-java -.. pending/fault-tolerance-scala -.. pending/Feature Stability Matrix -.. pending/futures-scala -.. pending/getting-started -.. pending/guice-integration -.. pending/Home -.. pending/http -.. pending/issue-tracking -.. pending/language-bindings -.. pending/licenses -.. pending/logging -.. pending/Migration-1.0-1.1 -.. pending/migration-guide-0.10.x-1.0.x -.. pending/migration-guide-0.7.x-0.8.x -.. pending/migration-guide-0.8.x-0.9.x -.. pending/migration-guide-0.9.x-0.10.x -.. pending/migration-guides -.. pending/Recipes -.. pending/release-notes -.. pending/remote-actors-java -.. pending/remote-actors-scala -.. pending/routing-java -.. pending/routing-scala -.. pending/scheduler -.. pending/security -.. pending/serialization-java -.. pending/serialization-scala -.. pending/servlet -.. pending/slf4j -.. pending/sponsors -.. pending/stm -.. pending/stm-java -.. pending/stm-scala -.. pending/team -.. pending/test -.. pending/testkit -.. pending/testkit-example -.. pending/third-party-integrations -.. pending/transactors-java -.. pending/transactors-scala -.. pending/tutorial-chat-server-java -.. pending/tutorial-chat-server-scala -.. pending/typed-actors-java -.. pending/typed-actors-scala -.. pending/untyped-actors-java -.. pending/use-cases -.. pending/web Links ===== diff --git a/akka-docs/manual/building-akka.rst b/akka-docs/intro/building-akka.rst similarity index 100% rename from akka-docs/manual/building-akka.rst rename to akka-docs/intro/building-akka.rst diff --git a/akka-docs/manual/configuration.rst b/akka-docs/intro/configuration.rst similarity index 100% rename from akka-docs/manual/configuration.rst rename to akka-docs/intro/configuration.rst diff --git a/akka-docs/manual/examples/Pi.scala b/akka-docs/intro/examples/Pi.scala similarity index 100% rename from akka-docs/manual/examples/Pi.scala rename to akka-docs/intro/examples/Pi.scala diff --git a/akka-docs/manual/getting-started-first-java.rst b/akka-docs/intro/getting-started-first-java.rst similarity index 100% rename from akka-docs/manual/getting-started-first-java.rst rename to akka-docs/intro/getting-started-first-java.rst diff --git a/akka-docs/manual/getting-started-first-scala.rst b/akka-docs/intro/getting-started-first-scala.rst similarity index 100% rename from akka-docs/manual/getting-started-first-scala.rst rename to akka-docs/intro/getting-started-first-scala.rst diff --git a/akka-docs/manual/getting-started-first.rst b/akka-docs/intro/getting-started-first.rst similarity index 100% rename from akka-docs/manual/getting-started-first.rst rename to akka-docs/intro/getting-started-first.rst diff --git a/akka-docs/intro/index.rst b/akka-docs/intro/index.rst new file mode 100644 index 0000000000..70f6caf3ce --- /dev/null +++ b/akka-docs/intro/index.rst @@ -0,0 +1,11 @@ +Introduction +============ + +.. toctree:: + :maxdepth: 2 + + why-akka + getting-started-first-scala + getting-started-first-java + building-akka + configuration diff --git a/akka-docs/manual/pi-formula.png b/akka-docs/intro/pi-formula.png similarity index 100% rename from akka-docs/manual/pi-formula.png rename to akka-docs/intro/pi-formula.png diff --git a/akka-docs/manual/why-akka.rst b/akka-docs/intro/why-akka.rst similarity index 100% rename from akka-docs/manual/why-akka.rst rename to akka-docs/intro/why-akka.rst diff --git a/akka-docs/manual/more.png b/akka-docs/manual/more.png deleted file mode 100644 index 3eb7b05c84809454c095bcb61b27d83585540bb2..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1502 zcmeAS@N?(olHy`uVBq!ia0y~yU{C;I4mJh`hT^KKFANL}EX7WqAsieW95oy%9SjT% zk|nMYCBgY=CFO}lsSM@i<$9TU*~Q6;1*v-ZMd`EO*+?-kuoif_IEF;D9-S7QBN8fc z{Qv!#H|O5ncIDoi)}U@yO|gadcDOt32;uP!OYU&HC?4rDuV$kA;y@ptD?gTWdM6!d zS)tNm>KNkWAfk1NskLcJl-JAFd*v_7^oy!0szW@vcpba1`g{AYCmOj`=Rb%i<|)a>`yt`uO3u&M7Y zj=cNJN+{#&k1dwpV;v?m-C9+Z`u4K^w8;Wz<>qhuv5!-LgGtNnY~C52wPMoK_XjQD z_`2fwa?^YAj7l6r3LGpwayC=qInJ*#FEU;Jn*F?9?(N+5^UwWnIKKQTLxw_Qc;}1A zG(FKZ=Wbm4A^7Vn_lBD-XW5FTCQVrS==rkuhlMwOT+g>>>H8h&jQ#%6zD&Q<#KN<; zUiE(_dR}9(%~}D=b2S`67v=Xdbo+XkC2r)LexkWcM&@62{f{(_f(fc-zxVF4%w_EN zFP?NDo%P)(UEc2avT$)-mn&RO&kcMen>803Sa8key^(V;joHw;uC zpL1nv&!3apDgGzUw&XaI-25;fE<42OngL5*uGxcY z@BFV!DN;${Re#7ZVYS#{6WyM^o(P6-%MUFV`S4@Q*3hF{Ur#@CcLB>;I|hcyTn&@$ zRjND143?CuJl80^=CGN&@X?o#9eKy@eb2wR-{X0TNXPx}cVExD^@Qv8;tdh)4P0!^ zGadw`IVifH5^dRcqq1jqvq1_AL%_1L%r7l1E*9A&&3ab0Km7jO&Z)Z0v$M6tM4mo- zrj+o-VFDN1g!R)79?bh=edE+#&rL zZp?jcx| z&x^MmH_Z(%e`Q(p*lgDMxjf#Q(tqRrMwnHEF)qCD*mb99$_b5}Z2=EfxTM$5u3hnT zH{-M$PrkqM?cAvUw&-)h8s^1S;%Pfy3(Cx$kbXPLNvCq|{nh6Ftmo%3y7eA@*r4Ye z&?+3L+!R0SyVRM8SKnXNu5?!QZh0Gcrs#TdMZ%eV7w$yv%_@L)n>VXH=s%k2*ZqD7a~ z%Kdm8eNQY|Z^!4?GD*rsrD4kU#6Jx})4jHBm($3c6TSJx+lZ1oIsf;*eeFE|xL-f- zAvT9h$rOf9W{Jzccg_^_KdDlXRsHz5Yv^g|SMmI_lh1YghV#q)G`J$jr)sQm>A^RX zTV+*jmsltLePr2HeAasERo2Z@XDwVUZ0`4#vxI+3WSWieO34#bI=@WyW-v3pJ=xB~ z=uVr9it&>Zih&ygO2y6x-tA)c+7SNguKL#*lB~xc&UCr7R3~lP