Merge pull request #36 from idle-org/test-new-doc

Test new doc
This commit is contained in:
Maximilien Rigaut 2022-06-16 02:04:57 +02:00 committed by GitHub
commit 237a417396
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
19 changed files with 196 additions and 134 deletions

View File

@ -10,7 +10,7 @@ shortcuts:
tab_bnw: 'tab_bnw_imported'
tab_color: 'tab_colour_imported'
custom_permutation: 'custom_permutated'
empty: ''
start: |
<!doctype html>
<html lang="en">

View File

@ -0,0 +1,48 @@
Structural Elements:
<<div
This is a div
div>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
<<article
This is an article
article>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
<<aside
This is an aside
aside>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
<<section
This is a section
section>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
<<div
<<article
<<aside
<<section
Text
section>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
aside>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
article>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
div>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
# Header 1 #{class='blue', 123}{{cinsertion}}[var='test', number=11]
! Display 1 !{class='blue', 123}{{cinsertion}}[var='test', number=11]
Inline Element:
[Link text]('http://this.is.a.link')
*This is in italic*
**This is strong**
~~This is stricken through~~
__This is underlined__
(#1)This is a custom span(#1)
Oneline elements:
- This is an unordered list item
- This is an unordered list item
- This is an unordered list item{class='blue', 123}{{cinsertion}}[var='test', number=11]
#. This is an ordered list item
#. This is an ordered list item
#. This is an ordered list item{class='blue', 123}{{cinsertion}}[var='test', number=11]
This is a long text segment. This is a long text segment. This is a long text segment. This is a long text segment. This is a long text segment.
This is still the same long text segment. This is still the same long text segment. This is still the same long text segment.
Use a double linebreak to force linebreaks.

View File

@ -1,51 +1,28 @@
@[start]['bootstrap']
Structural Elements:
@[start]['Bootstraparse']
<<div
This is a div
div>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
<<article
This is an article
article>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
<<aside
This is an aside
aside>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
<<section
This is a section
section>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
<<header
<<div
<<article
<<aside
<<section
Text
section>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
aside>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
article>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
div>>{class='blue', 123}{{cinsertion}}[var='test', number=11]
# Header 1 #{class='blue', 123}{{cinsertion}}[var='test', number=11]
! Display 1 !{class='blue', 123}{{cinsertion}}[var='test', number=11]
<<div
Bootstraparse
div>>{{blog-header-logo text-dark text-center border-bottom}}
div>>{{row flex-nowrap justify-content-between align-items-center}}
header>>{{blog-header py-3}}
<<div
# What is bootstraparse ? #
bootstraparse is a tool that allows you to bootstrap your own project.
In a very small number of steps, you can create a new project with the
following features:
- Imports, with the <code>: :< filename > </code>syntax you can import another file and have it's contents dumped into your file.
- Markup, a subset of markdown is already supported and the rest is incomming !
- Aliases : With the <code> @[alias_name] </code> syntax you can create an alias for a string of text, with replacement capabilities.
- Images: With the <code> @&#123;imagename&#125; </code> syntax you can specify an image template to import, with replacement capabilities.
And much much more !
Inline Element:
[Link text]('http://this.is.a.link')
*This is in italic*
**This is strong**
~~This is stricken through~~
__This is underlined__
(#1)This is a custom span(#1)
Oneline elements:
- This is an unordered list item
- This is an unordered list item
- This is an unordered list item{class='blue', 123}{{cinsertion}}[var='test', number=11]
#. This is an ordered list item
#. This is an ordered list item
#. This is an ordered list item{class='blue', 123}{{cinsertion}}[var='test', number=11]
This is a long text segment. This is a long text segment. This is a long text segment. This is a long text segment. This is a long text segment.
This is still the same long text segment. This is still the same long text segment. This is still the same long text segment.
Use a double linebreak to force linebreaks.
We encourage you to read the [documentation]("apidoc/index.html") to learn more about bootstraparse
or explore the [source code]("https://github.com/idle-org/bootstraparse")
div>>{{nav-scroller py-1 mb-2}}
div>>{{container}}
@[end]

View File

@ -0,0 +1,5 @@
"""
Bootstraparse is a tool to parse a folder and create a website from it.
After installing it with pip, you can use it by running the following command:
- bootstraparse <origin> <destination>
"""

View File

@ -1,6 +1,6 @@
#!/usr/bin/python3
# Main program, use this to start parsing
""" Main program, use this to start parsing"""
from bootstraparse.modules import sitecreator, error_mngr
import argparse

View File

@ -0,0 +1,3 @@
"""
The modules in this folder are used to parse the website.
"""

View File

@ -1,11 +1,11 @@
# Interprets config files
# The Config will be loaded by the environment at runtime and should be accessed that way
# Usage:
# from bootstraparse.modules.config import ConfigLoader
# config = ConfigLoader([list of config files], extensions=[list of extensions])
# config['file']['key']
# The ConfigLoader class has load_from_file and load_from_folder methods and __getitem__ for accessing loaded elements
"""Interprets config files
The Config will be loaded by the environment at runtime and should be accessed that way
Usage:
- from bootstraparse.modules.config import ConfigLoader
- config = ConfigLoader([list of config files], extensions=[list of extensions])
- config['file']['key']
The ConfigLoader class has load_from_file and load_from_folder methods and __getitem__ for accessing loaded elements
"""
import os
import rich

View File

@ -1,16 +1,16 @@
# Interprets where the parser is located and resolves errors
# You're probably here for the ContextManager class.
# Containers have class_name, debug_map and validate methods for debug,
# self.content: accessible via __getitem__, __setitem__, add, __len__, __iter__ and __getslice__.
# self.optionals: accessible via __rshift__ (remapped to return self.map[other]())
# and self.map: accessible via __invert__ (remapped to return self.optionals)
# Usage:
# from bootstraparse.modules.context_mngr import ContextManager
# ctx = ContextManager()
# container = BaseContainer()
# container[number] -> The number element in the content
# "class_insert" >> container[number] -> Get an element from one of the mapped methods
"""Interprets where the parser is located and resolves errors
You're probably here for the ContextManager class.
Containers have class_name, debug_map and validate methods for debug,
- self.content: accessible via __getitem__, __setitem__, add, __len__, __iter__ and __getslice__.
- self.optionals: accessible via __rshift__ (remapped to return self.map[other]())
- and self.map: accessible via __invert__ (remapped to return self.optionals)
Usage:
- from bootstraparse.modules.context_mngr import ContextManager
- ctx = ContextManager()
- container = BaseContainer()
- container[number] -> The number element in the content
- "class_insert" >> container[number] -> Get an element from one of the mapped methods
"""
from bootstraparse.modules import syntax, error_mngr, export
from bootstraparse.modules.error_mngr import MismatchedContainerError, log_exception, log_message, LonelyOptionalError # noqa

View File

@ -1,19 +1,20 @@
# Module for containing super important variables
# Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and
# self.wasInitialised and integrity_check for debug.
# __getattr__ and __setattr__ check for existing super, s or m parameters, returns error if not found.
# Usage:
# from bootstraparse.modules.environment import Environment
# env = Environment()
# env.integrity_check() -> Checks if all mandatory parameters are set.
# env["config"] -> returns config object
# env["template"] -> returns template object
# env["export_mngr"] -> returns export manager object
# env["global_path"] -> returns global path ???
# env["user_path"] -> returns user path ???
# env["site_path"] -> returns site path
# env["export"] -> returns export object ???
# env["site_crawler"] -> returns site crawler object
"""Module for containing super important variables
Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and
- self.wasInitialised and integrity_check for debug.
- __getattr__ and __setattr__ check for existing super, s or m parameters, returns error if not found.
Usage:
- from bootstraparse.modules.environment import Environment
- env = Environment()
- env.integrity_check() -> Checks if all mandatory parameters are set.
- env["config"] -> returns config object
- env["template"] -> returns template object
- env["export_mngr"] -> returns export manager object
- env["global_path"] -> returns global path ???
- env["user_path"] -> returns user path ???
- env["site_path"] -> returns site path
- env["export"] -> returns export object ???
- env["site_crawler"] -> returns site crawler object
"""
from bootstraparse.modules import error_mngr

View File

@ -1,12 +1,14 @@
# Dedicated module for defining and interpreting errors as well as generating error messages
# You're probably here for log_message or log_exception.
# They take: message, level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL")
# There's also a dict_check(dic, *args) that returns true if all args are keys in the dict.
# Usage:
# from bootstraparse.modules.error_mngr import log_message, log_exception
# log_message("This is a message", level="INFO") level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL")
# log_exception(Exception("This is an exception"), level="ERROR")
# dict_check({"a": 1, "b": 2}, "a", "b") # returns [True, True]
"""
Dedicated module for defining and interpreting errors as well as generating error messages
You're probably here for log_message or log_exception.
- They take: message, level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL")
There's also a dict_check(dic, *args) that returns true if all args are keys in the dict.
Usage:
- from bootstraparse.modules.error_mngr import log_message, log_exception
- log_message("This is a message", level="INFO") level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL")
- log_exception(Exception("This is an exception"), level="ERROR")
- dict_check({"a": 1, "b": 2}, "a", "b") # returns [True, True]
"""
import logging
import traceback

View File

@ -1,10 +1,12 @@
# Module for final generation of the translated website
# Usage:
# from bootstraparse.modules.export import ExportManager, ExportRequest, ExportResponse
# rqs = ExportRequest("strucural_elements", "div", "optionals", {"id": "my_id", "class": "my_class"})
# rsp = ExportResponse("start_string", "end_string")
# em = ExportManager(config_file, template_file)
# em(ExportRequest()) -> ExportResponse()
"""
Module for final generation of the translated website
Usage:
- from bootstraparse.modules.export import ExportManager, ExportRequest, ExportResponse
- rqs = ExportRequest("strucural_elements", "div", "optionals", {"id": "my_id", "class": "my_class"})
- rsp = ExportResponse("start_string", "end_string")
- em = ExportManager(config_file, template_file)
- em(ExportRequest()) -> ExportResponse()
"""
from io import StringIO
from bootstraparse.modules import config, pathresolver, error_mngr, context_mngr

View File

@ -1,9 +1,10 @@
# Main parser, gets config files and parses them for the context manager.
# parse_line takes a io and outputs it all as a list of parsed elements
# Usage:
# from bootstraparse.modules.parser import parse_line
# parse_line(io) -> [element, element, element]
"""
Main parser, gets config files and parses them for the context manager.
parse_line takes a io and outputs it all as a list of parsed elements
Usage:
- from bootstraparse.modules.parser import parse_line
- parse_line(io) -> [element, element, element]
"""
from io import StringIO
import bootstraparse.modules.syntax as syntax

View File

@ -1,11 +1,12 @@
# Module for resolving relative path problems
# PathResolver takes a relative path in the module and outputs the absolute path,
# BoostraPath can deal with relative paths in the installation folder.
# Usage:
# from bootstraparse.modules.pathresolver import PathResolver, b_path
# b_path("../relative/path/to/file") # returns absolute path to file from the bootstraparse folder
# path= PathResolver("../relative/path/to/file") # Make a PathResolver object pointing at the first path given
"""
Module for resolving relative path problems
PathResolver takes a relative path in the module and outputs the absolute path,
BoostraPath can deal with relative paths in the installation folder.
Usage:
- from bootstraparse.modules.pathresolver import PathResolver, b_path
- b_path("../relative/path/to/file") # returns absolute path to file from the bootstraparse folder
- path= PathResolver("../relative/path/to/file") # Make a PathResolver object pointing at the first path given
"""
import os

View File

@ -1,11 +1,12 @@
# Module for pre-parsing user files in preparation for the parser
# Usage:
# from bootstraparse.modules.preparser import preparser
# pp = preparser(file, enviroment)
# pp.do_import() # imports all the modules and adds them to the file, do the same for all the files that are to be imported # noqa
# pp.do_replacements() # replaces all images and shortcuts in the file
# pp.readlines() # returns the lines of ORIGINAL file
# pp.get_all_lines() # returns the lines of the file after replacements and imports
"""Module for pre-parsing user files in preparation for the parser
Usage:
- from bootstraparse.modules.preparser import preparser
- pp = preparser(file, enviroment)
- pp.do_import() # imports all the modules and adds them to the file, do the same for all the files that are to be imported - # noqa
- pp.do_replacements() # replaces all images and shortcuts in the file
- pp.readlines() # returns the lines of ORIGINAL file
- pp.get_all_lines() # returns the lines of the file after replacements and imports
"""
import os

View File

@ -1,4 +1,14 @@
# Module for file and directories repartition
"""
Module for file and directories repartition
Usage:
- from bootstraparse.modules import SiteCrawler
- crawler = SiteCrawler(origin_path, dest_path, _env)
- crawler.set_all_preparsers()
- crawler.copy_unparsable_files()
- for element, destination in crawler:
- - save(preparse_parse(element), destination, _env)
"""
import os
import shutil
from bootstraparse.modules import pathresolver, preparser, error_mngr, environment, export

View File

@ -1,4 +1,9 @@
# Module sequencing the successive actions necessary for website building
"""
Module sequencing the successive actions necessary for website building
Usage:
- create_website(origin, destination)
"""
import os
from bootstraparse.modules import pathresolver, sitecrawler, environment, config, export, parser, context_mngr

View File

@ -1,3 +1,4 @@
"""
# Dedicated module for the syntax of all the parsing
# All tokens inherit a SemanticType among SemanticType, ExplicitSemanticType and EmptySemanticType
# All tokens have a label, and __eq__ and __ne__ methods.
@ -8,6 +9,7 @@
# line_to_replace.parse_line('string') # returns a List of tokens parsed for replacements
# imports.parse_line('string', True) # returns a List of tokens parsed for imports
# any_token.create_diagram("filename") # Debugging
"""
import os
from itertools import zip_longest

View File

@ -1 +1,3 @@
# Module for interpreting default or custom templates.
"""
Module for interpreting default or custom templates.
"""

View File

@ -1,11 +1,13 @@
###############################################################################
# List of tools for testing
###############################################################################
# Usage:
# from bootstraparse.modules.tools import __GLk, __GL, find_*_in_file
# __GLk(n) # Returns a file link n traceback objects back
# __GL() # Returns a line number at current position
# find_*_in_file(file) # Try to find (class, function or variable) in file and return its line number
"""
List of tools for testing
=========================
Usage:
- from bootstraparse.modules.tools import __GLk, __GL, find_*_in_file
- __GLk(n) # Returns a file link n traceback objects back
- __GL() # Returns a line number at current position
- find_*_in_file(file) # Try to find (class, function or variable) in file and return its line number
"""
import inspect
import os