Skip to content

Commit

Permalink
Fix install story + grokwiki.
Browse files Browse the repository at this point in the history
  • Loading branch information
icemac committed Dec 21, 2023
1 parent 723c5c0 commit 35da7b9
Show file tree
Hide file tree
Showing 13 changed files with 28 additions and 54 deletions.
2 changes: 1 addition & 1 deletion CREDITS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ CREDITS

* Reinout van Rees

* Maurits van Rees
* Michael Howitz (release manager)

* ME GROK (team mascot)

Expand Down
28 changes: 6 additions & 22 deletions INSTALL.txt → INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ applications you might consider to use `grokproject
<http://pypi.python.org/pypi/grokproject>`_ instead.


Running the demo applications
-----------------------------
Running the demo application
----------------------------

You can start Zope with the demo applications installed with the
You can start Zope with the demo application installed with the
following command:

$ bin/paster serve parts/etc/deploy.ini
Expand All @@ -57,25 +57,9 @@ installed in the ``bin`` directory::

$ bin/test

Generating the website files
Generating the documentation
----------------------------

Grok's tutorial documents for the website can easily be generated
using the following scripts in ``bin``::

$ bin/grokdocs2html

The output is by default written to ``build/html/``.

Run::

$ bin/grokdocs2html -h

to get all options supported.

With::

$ bin/grokdocs2latex
Grok's tutorial documents can easily be generated using the following call::

you get LaTeX output which can be used to generate PDF docs. This
requires a working LaTeX installed on your system.
$ tox -e docs
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ wiring components together. That means neither a configuration
language like ZCML nor a lot of repetition are needed to create a web
application with grok.

You can find out much more about Grok at our `<website
https://web.archive.org/web/20221005185405/http://grok.zope.org>`_.
You can find out much more about Grok at our `website
<https://web.archive.org/web/20221005185405/http://grok.zope.org>`_.

Who is grok?
============
Expand Down Expand Up @@ -52,4 +52,4 @@ You can also get grok from GitHub::

git clone https://github.com/zopefoundation/grok.git

Then follow the instructions of ``INSTALL.txt``.
Then follow the instructions in ``INSTALL.rst``.
5 changes: 3 additions & 2 deletions buildout.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[buildout]
extends =
https://raw.githubusercontent.com/zopefoundation/groktoolkit/3.0.0a1/grok.cfg
https://zopefoundation.github.io/groktoolkit/releases/3.0/grok-versions.cfg
parts =
interpreter
mkdirs
Expand All @@ -25,8 +25,9 @@ collective.recipe.template = >= 2.2
[interpreter]
recipe = zc.recipe.egg
eggs =
PasteScript
grokwiki
zest.releaser
scripts = paster
interpreter = grokpy

[mkdirs]
Expand Down
2 changes: 1 addition & 1 deletion docs/changes.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. include:: ../CHANGES.txt
.. include:: ../CHANGES.rst
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@
# built documents.
#
# The short X.Y version.
version = '1.4'
version = '4.1'
# The full version, including alpha/beta/rc tags.
release = '1.4'
release = version
if release.endswith('dev'):
release = '%s (unreleased)' % release

Expand Down Expand Up @@ -132,7 +132,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down Expand Up @@ -229,4 +229,4 @@


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
intersphinx_mapping = {'python': ('http://docs.python.org/', None)}
2 changes: 1 addition & 1 deletion docs/copyright.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Copyright

Grok and this documentation is:

Copyright © 2006-2009 Zope Community and Contributors. All rights reserved.
Copyright © 2006-2023 Zope Community and Contributors. All rights reserved.

----------

Expand Down
2 changes: 1 addition & 1 deletion docs/development.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. include:: ../INSTALL.txt
.. include:: ../INSTALL.rst
2 changes: 1 addition & 1 deletion docs/introduction.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. include:: ../README.txt
.. include:: ../README.rst
17 changes: 0 additions & 17 deletions documentation.cfg

This file was deleted.

2 changes: 1 addition & 1 deletion etc/site.zcml.in
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
public access -->
<grant permission="zope.View"
principal="zope.Anybody" />
<grant permission="zope.app.dublincore.view"
<grant permission="zope.dublincore.view"
principal="zope.Anybody" />

<role id="zope.Manager" title="Site Manager" />
Expand Down
1 change: 1 addition & 0 deletions grokwiki/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
'grokui.admin',
'grokcore.startup',
'grokcore.message',
'zope.dublincore',
],
entry_points="""
[console_scripts]
Expand Down
5 changes: 5 additions & 0 deletions grokwiki/src/grokwiki/page.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ class Layout(grok.View):
pass


class StaticResource(grok.DirectoryResource):
grok.name('grokwiki')
grok.path('static')


class Index(grok.View):

def update(self):
Expand Down

0 comments on commit 35da7b9

Please sign in to comment.